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 - uritemplate

2.0.0 - 2016-08-29

  • Merge uritemplate.py into uritemplate

Changelog - uritemplate.py

3.0.1 - 2015-08-29

  • Deprecate in favor of uritemplate. This package is now a metapackage that depends on uritemplate.

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.py-3.0.1.tar.gz (30.5 kB view details)

Uploaded Source

Built Distribution

uritemplate.py-3.0.1-py2.py3-none-any.whl (4.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file uritemplate.py-3.0.1.tar.gz.

File metadata

File hashes

Hashes for uritemplate.py-3.0.1.tar.gz
Algorithm Hash digest
SHA256 698a48f7196efc43dd264d2e56f058ca0ae8b80dec3012975c2f3af239f5c235
MD5 18590be026579556aafa5afbd7840bfb
BLAKE2b-256 d06d17524956e68bbb8096b9de13c7715c1cf4615d05a991288ba3ea5a5a8c20

See more details on using hashes here.

File details

Details for the file uritemplate.py-3.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for uritemplate.py-3.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 520c52bf071d628a00fd9e8b0a1375b82a5ded2f4eb81ee5f5dbecf6554de75b
MD5 048fdd40d9eb87bd18cc7a817e30f3fb
BLAKE2b-256 cd12cd8bb2551dc1b08cc8fd9f4cb445cfdd6ccce0920d78fac771692612a977

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