Skip to main content

Parsing and validation of URIs (RFC 3986) and IRIs (RFC 3987)

Project description

This module provides regular expressions according to RFC 3986 “Uniform Resource Identifier (URI): Generic Syntax” and RFC 3987 “Internationalized Resource Identifiers (IRIs)”, and utilities for composition and relative resolution of references.

API

match (string, rule=’IRI_reference’)

Convenience function for checking if string matches a specific rule.

Returns a match object or None:

>>> assert match('%C7X', 'pct_encoded') is None
>>> assert match('%C7', 'pct_encoded')
>>> assert match('%c7', 'pct_encoded')
parse (string, rule=’IRI_reference’)

Parses string according to rule into a dict of subcomponents.

If rule is None, parse an IRI_reference without validation.

If regex is available, any rule is supported; with re, rule must be ‘IRI_reference’ or some special case thereof (‘IRI’, ‘absolute_IRI’, ‘irelative_ref’, ‘irelative_part’, ‘URI_reference’, ‘URI’, ‘absolute_URI’, ‘relative_ref’, ‘relative_part’).

>>> d = parse('http://tools.ietf.org/html/rfc3986#appendix-A',
...           rule='URI')
>>> assert all([ d['scheme'] == 'http',
...              d['authority'] == 'tools.ietf.org',
...              d['path'] == '/html/rfc3986',
...              d['query'] == None,
...              d['fragment'] == 'appendix-A' ])
compose (**parts)

Returns an URI composed from named parts.

resolve (base, uriref, strict=True, return_parts=False)

Resolves an URI reference relative to a base URI.

Test cases:

>>> base = resolve.test_cases_base
>>> for relative, resolved in resolve.test_cases.items():
...     assert resolve(base, relative) == resolved

If return_parts is True, returns a dict of named parts instead of a string.

Examples:

>>> assert resolve('urn:rootless', '../../name') == 'urn:name'
>>> assert resolve('urn:root/less', '../../name') == 'urn:/name'
>>> assert resolve('http://a/b', 'http:g') == 'http:g'
>>> assert resolve('http://a/b', 'http:g', strict=False) == 'http://a/g'
patterns

A dict of regular expressions with useful group names. Compilable (with regex only) without need for any particular compilation flag.

[bmp_][u]patterns[_no_names]

Alternative versions of patterns. [u]nicode strings without group names for the re module. BMP only for narrow builds.

get_compiled_pattern (rule, flags=0)

Returns a compiled pattern object for a rule name or template string.

Usage for validation:

>>> uri = get_compiled_pattern('^%(URI)s$')
>>> assert uri.match('http://tools.ietf.org/html/rfc3986#appendix-A')
>>> assert not get_compiled_pattern('^%(relative_ref)s$').match('#f#g')
>>> from unicodedata import lookup
>>> smp = 'urn:' + lookup('OLD ITALIC LETTER A')  # U+00010300
>>> assert not uri.match(smp)
>>> m = get_compiled_pattern('^%(IRI)s$').match(smp)

On narrow builds, non-BMP characters are (incorreclty) excluded:

>>> assert NARROW_BUILD == (not m)

For parsing, some subcomponents are captured in named groups (only if regex is available, otherwise see parse):

>>> match = uri.match('http://tools.ietf.org/html/rfc3986#appendix-A')
>>> d = match.groupdict()
>>> if REGEX:
...     assert all([ d['scheme'] == 'http',
...                  d['authority'] == 'tools.ietf.org',
...                  d['path'] == '/html/rfc3986',
...                  d['query'] == None,
...                  d['fragment'] == 'appendix-A' ])

>>> for r in patterns.keys():
...     assert get_compiled_pattern(r)
format_patterns (**names)

Returns a dict of patterns (regular expressions) keyed by rule names for URIs and rule names for IRIs.

See also the module level dicts of patterns, and get_compiled_pattern.

To wrap a rule in a named capture group, pass it as keyword argument: rule_name=’group_name’. By default, the formatted patterns contain no named groups.

Patterns are str instances (be it in python 2.x or 3.x) containing ASCII characters only.

Caveats:

  • with re, named capture groups cannot occur on multiple branches of an alternation

  • with re before python 3.3, \u and \U escapes must be preprocessed (see issue3665)

  • on narrow builds, character ranges beyond BMP are not supported

Dependencies

Some features require regex.

This package is tested on python 2.6, 2.7, 3.2, 3.3, 3.4 and 3.5. Note that in python<=3.2, characters beyond the Basic Multilingual Plane are not supported on narrow builds (see issue12729).

What’s new

version 1.3.6:

  • fixed a bug in IPv6 pattern:

    >>> assert match('::0:0:0:0:0.0.0.0', 'IPv6address')
    

version 1.3.4:

  • allowed for lower case percent encoding

version 1.3.3:

  • fixed a bug in resolve which left “../” at the begining of some paths

version 1.3.2:

  • convenience function match

  • patterns restricted to the BMP for narrow builds

  • adapted doctests for python 3.3

  • compatibility with python 2.6 (thanks to Thijs Janssen)

version 1.3.1:

  • some re compatibility: get_compiled_pattern, parse

  • dropped regex from setup.py requirements

version 1.3.0:

  • python 3.x compatibility

  • format_patterns

version 1.2.1:

  • compose, resolve

Support

This is free software. You may show your appreciation with a donation.

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

rfc3987-1.3.6.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

rfc3987-1.3.6-py2.py3-none-any.whl (13.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file rfc3987-1.3.6.tar.gz.

File metadata

  • Download URL: rfc3987-1.3.6.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for rfc3987-1.3.6.tar.gz
Algorithm Hash digest
SHA256 599801156e35b5054138585c92ab4d1b729b0f2feeb961b65347116764df4aa7
MD5 da7dabf5ee0b1426a2c6c4f8406ee0d3
BLAKE2b-256 1465b414c853e8d02a1011ef7587d1bd43478f87a2d58f127a4c794e1f778de1

See more details on using hashes here.

File details

Details for the file rfc3987-1.3.6-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for rfc3987-1.3.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0996b8bb785852d323687afb6ac0543072dd1e6e624505d45d10d1e40b24c8e4
MD5 eaa3061b361506363a17233a28e8eae6
BLAKE2b-256 e33c88b8f2790b38a99fcb9841102aada50f244998384e23fae12a262a311eea

See more details on using hashes here.

Supported by

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