API Documentation¶
Class tags¶
Check if a string (hyphen-separated) tag is valid.
Parameters: tag (str) – (hyphen-separated) tag. Returns: bool – True if valid.
Get the file date of the underlying data as a string.
Returns: date as string (for example: ‘2014-03-27’).
Gets a list of descriptions given the tag.
Parameters: tag (str) – (hyphen-separated) tag. Returns: list of string descriptions. The return list can be empty.
Get a list of non-existing string subtag(s) given the input string subtag(s).
Parameters: subtags – string subtag or a list of string subtags. Returns: list of non-existing string subtags. The return list can be empty.
Get a language
language_tags.Subtag.Subtag
of the subtag string.Parameters: subtag (str) – subtag. Returns: language language_tags.Subtag.Subtag
if exists, otherwise None.
Get a list of
language_tags.Subtag.Subtag
objects given the string macrolanguage.Parameters: macrolanguage (string) – subtag macrolanguage. Returns: a list of the macrolanguage language_tags.Subtag.Subtag
objects.Raises: Exception – if the macrolanguage does not exists.
Get a region
language_tags.Subtag.Subtag
of the subtag string.Parameters: subtag (str) – subtag. Returns: region language_tags.Subtag.Subtag
if exists, otherwise None.
Gets a list of
language_tags.Subtag.Subtag
objects where the description matches.Parameters: - description (str or RegExp) – a string or compiled regular expression. For example:
search(re.compile('\d{4}'))
if the description of the returned subtag must contain four contiguous numerical digits. - all (bool, optional) – If set on True grandfathered and redundant tags will be included in the return list.
Returns: list of
language_tags.Subtag.Subtag
objects each including the description. The return list can be empty.- description (str or RegExp) – a string or compiled regular expression. For example:
Get a list of existing
language_tags.Subtag.Subtag
objects given the input subtag(s).Parameters: subtags – string subtag or list of string subtags. Returns: a list of existing language_tags.Subtag.Subtag
objects. The return list can be empty.
Get a
language_tags.Tag.Tag
of a string (hyphen-separated) tag.Parameters: tag (str) – (hyphen-separated) tag. Returns: language_tags.Tag.Tag
.
Get a
language_tags.Subtag.Subtag
by subtag and type. Can be None if not exists.Parameters: Returns: language_tags.Subtag.Subtag
if exists, otherwise None.
Get the types of a subtag string (excludes redundant and grandfathered).
Parameters: subtag (str) – subtag. Returns: list of types. The return list can be empty.
Class Tag¶
Tags for Identifying Languages based on BCP 47 (RFC 5646) and the latest IANA language subtag registry.
Parameters: tag (str) – (hyphen-separated) tag. Get the date string of grandfathered or redundant tag when it was added to the registry.
Returns: added date string if the deprecated or redundant tag has one, otherwise None.
Get the deprecation date of grandfathered or redundant tag if the tag is deprecated.
Returns: deprecation date string if the deprecated or redundant tag has one, otherwise None.
Get the list of descriptions of the grandfathered or redundant tag.
Returns: list of descriptions. If no descriptions available, it returns an empty list.
Get the
language_tags.Tag.Tag.Error
of a specific Tag error code. The error creates a message explaining the error. It also refers to the respective (sub)tag(s).Parameters: - code (int) –
a Tag error error:
- 1 = Tag.ERR_DEPRECATED
- 2 = Tag.ERR_NO_LANGUAGE
- 3 = Tag.ERR_UNKNOWN,
- 4 = Tag.ERR_TOO_LONG
- 5 = Tag.ERR_EXTRA_REGION
- 6 = Tag.ERR_EXTRA_EXTLANG
- 7 = Tag.ERR_EXTRA_SCRIPT,
- 8 = Tag.ERR_DUPLICATE_VARIANT
- 9 = Tag.ERR_WRONG_ORDER
- 10 = Tag.ERR_SUPPRESS_SCRIPT,
- 11 = Tag.ERR_SUBTAG_DEPRECATED
- 12 = Tag.ERR_EXTRA_LANGUAGE
- subtag – string (sub)tag or list of string (sub)tags creating the error.
Returns: An exception class containing: a Tag error input code, the derived message with the given (sub)tag(s). input
- code (int) –
Get the errors of the tag. If invalid then the list will consist of errors containing each a code and message explaining the error. Each error also refers to the respective (sub)tag(s).
Returns: list of errors of the tag. If the tag is valid, it returns an empty list.
Get format according to algorithm defined in RFC 5646 section 2.1.1.
Returns: formatted tag string.
Get the language
language_tags.Subtag.Subtag
of the tag.Returns: language language_tags.Subtag.Subtag
that is part of the tag. The return can be None.
Get the preferred
language_tags.Tag.Tag
of the deprecated or redundant tag.Returns: preferred language_tags.Tag.Tag
if the deprecated or redundant tag has one, otherwise None.
Get the region
language_tags.Subtag.Subtag
of the tag.Returns: region language_tags.Subtag.Subtag
that is part of the tag. The return can be None.
Get the script
language_tags.Subtag.Subtag
of the tag.Returns: script language_tags.Subtag.Subtag
that is part of the tag. The return can be None.
Get the
language_tags.Subtag.Subtag
objects of the tag.Returns: list of language_tags.Subtag.Subtag
objects that are part of the tag. The return list can be empty.
Get the type of the tag (either grandfathered, redundant or tag see RFC 5646 section 2.2.8.).
Returns: string – type of the tag.
Checks whether the tag is valid.
Returns: Bool – True if valid otherwise False.
Class Subtag¶
A subtag is a part of the hyphen-separated
language_tags.Tag.Tag
.Parameters: Returns: raise Error: Checks for Subtag.ERR_NONEXISTENT
andSubtag.ERR_TAG
.Get the date when the subtag was added to the registry.
Returns: date (as string) when the subtag was added to the registry.
Get the comments of the subtag.
Returns: list of comments. The return list can be empty.
Get the deprecation date.
Returns: deprecation date as string if subtag is deprecated, otherwise None.
Get the subtag description.
Returns: list of description strings.
Get the subtag code conventional format according to RFC 5646 section 2.1.1.
Returns: string – subtag code conventional format.
Get the preferred subtag.
Returns: preferred language_tags.Subtag.Subtag
if exists, otherwise None.
Get the subtag scope.
Returns: string subtag scope if exists, otherwise None.
Get the language’s default script of the subtag (RFC 5646 section 3.1.9)
Returns: string – the language’s default script.
Get the subtag type.
Returns: string – either ‘language’, ‘extlang’, ‘script’, ‘region’ or ‘variant’.