Skip to main content

URI templates

Project description

uritemplate

DocumentationGitHubBitBucketTravis-CI

Simple python library to deal with URI Templates. The API looks like

from uritemplate import URITemplate, expand

# NOTE: URI params must be strings not integers

gist_uri = 'https://api.github.com/users/sigmavirus24/gists{/gist_id}'
t = URITemplate(gist_uri)
print(t.expand(gist_id='123456'))
# => https://api.github.com/users/sigmavirus24/gists/123456

# or
print(expand(gist_uri, gist_id='123456'))

# also
t.expand({'gist_id': '123456'})
print(expand(gist_uri, {'gist_id': '123456'}))

Where it might be useful to have a class

import requests

class GitHubUser(object):
    url = URITemplate('https://api.github.com/user{/login}')
    def __init__(self, name):
        self.api_url = url.expand(login=name)
        response = requests.get(self.api_url)
        if response.status_code == 200:
            self.__dict__.update(response.json())

When the module containing this class is loaded, GitHubUser.url is evaluated and so the template is created once. It’s often hard to notice in Python, but object creation can consume a great deal of time and so can the re module which uritemplate relies on. Constructing the object once should reduce the amount of time your code takes to run.

Installing

pip install uritemplate.py

License

Modified BSD license

Changelog

2.0.0 - 2016-08-20

1.0.1 - 2016-08-18

  • Fix some minor packaging problems.

1.0.0 - 2016-08-17

  • Fix handling of Unicode values on Python 2.6 and 2.7 for urllib.quote.

  • Confirm public stable API via version number.

0.3.0 - 2013-10-22

  • Add #partial to partially expand templates and return new instances of URITemplate.

0.2.0 - 2013-07-26

  • Refactor the library a bit and add more tests.

  • Backwards incompatible with 0.1.x if using URIVariable directly from uritemplate.template

0.1.1 - 2013-05-19

  • Add ability to get set of variable names in the current URI

  • If there is no value or default given, simply return an empty string

  • Fix sdist

0.1.0 - 2013-05-14

  • Initial Release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uritemplate-2.0.0rc1.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

uritemplate-2.0.0rc1-py2-none-any.whl (10.3 kB view details)

Uploaded Python 2

File details

Details for the file uritemplate-2.0.0rc1.tar.gz.

File metadata

File hashes

Hashes for uritemplate-2.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 e0dd0052b2fe2797db325e069d805d1501ce3eda6ed51e1e5ac282b5ff686648
MD5 f6f2d275a0eb9abc1530dc90497685c1
BLAKE2b-256 0f02ea3394cf49c5efcb6fd78294179cb621bd88d88bca2df3095c6b1595c0f4

See more details on using hashes here.

File details

Details for the file uritemplate-2.0.0rc1-py2-none-any.whl.

File metadata

File hashes

Hashes for uritemplate-2.0.0rc1-py2-none-any.whl
Algorithm Hash digest
SHA256 22d028c9733089a014998f015337020b25ab08dd3eea663cfd01f7f182356555
MD5 ee70a668fb4694040428794059baa7b3
BLAKE2b-256 3242d5edeb07d44ccb83ced5356b0d75f1f60aa8455cbe42b6f1e5db7b523de5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page