Skip to main content

Implementation of RFC 6570 URI Templates

Project description

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

License

Modified BSD license

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-4.0.0.tar.gz (31.9 kB view details)

Uploaded Source

Built Distribution

uritemplate-4.0.0-py2.py3-none-any.whl (9.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file uritemplate-4.0.0.tar.gz.

File metadata

  • Download URL: uritemplate-4.0.0.tar.gz
  • Upload date:
  • Size: 31.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for uritemplate-4.0.0.tar.gz
Algorithm Hash digest
SHA256 6f4c5b093c915d269df69f291028a72dfdcaf68c8345b92e180f31daf53c4971
MD5 6d7834d0720bf1fb669ad2a735000dc2
BLAKE2b-256 5e89780d5e63a016f4480b15a42ca0632b1b483bc6b85d84380017e4f4fcb5f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uritemplate-4.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for uritemplate-4.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9de62e39c3f7f7584982a4159d70e6aafda5a479a91cccc18e89ae865eab4ae4
MD5 380259f946812492d064456f05a659f5
BLAKE2b-256 91781b357eae88e20f8332efdb2e3780bf9ffb2781b7ac43d0a7fc5e556e7421

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