Structured parsing of ISRC (International Standard Recording Code), as defined in ISO 3901:2019
Project description
py-iso3901
Structured parsing of ISRC (International Standard Recording Code) in python, as defined in ISO 3901:2019.
Install
pip install -U iso3901
Usage Example
The most usual way to create object is via ISRC.parse
method:
>>> from iso3901 import ISRC
>>> data = ISRC.parse('ISRC GB-AJY-12-34567')
>>> data == ISRC.parse('GBAJY1234567') # Same as compact form
True
>>> data.country.name
'United Kingdom of Great Britain and Northern Ireland'
>>> data.owner
'GBAJY'
>>> data.prefix
'GB'
>>> data.year
12
>>> data.designation
34567
>>> data.agency
'PPL UK'
>>> str(data)
'GBAJY1234567'
>>> data.stringify()
'GB-AJY-12-34567'
>>> data.raw # Get back the original unparsed string
'ISRC GB-AJY-12-34567'
ISRC agency prefix validation is now supported since version 0.3.0
:
>>> data = ISRC.parse('QMDA71418090')
>>> data.country.name
'United States of America'
>>> data.country.alpha2, data.prefix
('US', 'QM')
>>> data.agency
'RIAA'
>>> data = ISRC.parse('ZZZZZ1234567')
>>> data.country.name
'Worldwide'
>>> data.country.alpha2
''
>>> data.agency
'International ISRC Registration Authority'
validate()
method is provided for simple validation:
>>> ISRC.validate('aa-xyz-01-23456')
True
>>> ISRC.validate('aa-xyz-012-3456')
False
If desired, ISRC prefix allocation status and agency names can be accessed directly. They are exported directly as standard enum
:
>>> from iso3901 import Agency, Allocation
>>> Agency.DK
<Agency.DK: 'GRAMEK DK'>
>>> Agency.DK == Agency['DK']
True
>>> Allocation.DK
<Allocation.DK: ......>
>>> Allocation.DK.agency == Agency.DK
True
>>> Allocation['DK'].country
Country(name='Denmark', alpha2='DK', alpha3='DNK', numeric='208', apolitical_name='Denmark')
>>> Allocation['XY']
Traceback (most recent call last):
......
KeyError: 'XY'
Caveats
In the very rare case that no data validation is desired, it is possible to initiate object directly. Be warned that supplying free form data would result in illegal ISRC code:
>>> data = ISRC('GBAJY', 12, 34567)
>>> str(data)
'GBAJY1234567'
>>> data = ISRC('Some Owner', 123, 456789)
>>> str(data)
'Some Owner123456789'
In case ISRC prefix isn't a legal allocated prefix, .country
and .agency
properties become None
:
>>> data = ISRC('ZYXWV', 12, 34567) # Exception if using ISRC.parse()
>>> type(data.country)
<class 'NoneType'>
>>> type(data.agency)
<class 'NoneType'>
Reference
Following documents are consulted when writing code:
Q&A
-
Why is there no validation for invalid registrants, such as
US-S1Z
which is mentioned in above documents?It is true that ISRC agencies has been repeatedly mentioning that some codes were "for illustrative purposes in documentation and training materials", and therefore are known invalid codes. However, registrant allocation info is not public; it is held privately within allocator of each nation (and most likely International ISRC Agency itself). It is practically impossible to exhaust and blacklist all examples used in various documents on internet. In single word: unenforceable.
-
Why is the year kept as integer and not python
datetime
structure?In ISRC standard, only the last 2 digit of year is available. It is easier to tell the actual year in some cases, but for years like '20', it is impossible to distinguish 1920 from 2020 via ISRC alone. Acoustic recording already existed around 1900; and some ancient recordings are known to directly use recording year (20's) in ISRC, such as Jimmie Rodgers'.
-
The "country code"
QM
is already known for use in United States, andZZ
reserved for International ISRC Agency, as described in various ISRC Bulletins. Is there any plan to add modern ISRC Registrant allocations and do a mapping between newer prefixes and countries?Actually, the newest bulletin dated 2015 had pushed a new standard that no more binds country with the 2-letter prefix. That said, since
0.3.0
version, country code is validated to conform to newest published prefixes — Jun 2024 as of writing. There exists quite a number of countries unmanaged by any recording industry agencies, so validation still provides some benefit.
Alternatives
If one only needs to check for validity of ISRC string, and no objectified access of various segments is needed, other python modules exist to provide such validation routine. For example:
However, so far this package provides the most rigorous validation among all of the choices, as it contains the newest country prefixes mapping.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file iso3901-0.3.3.tar.gz
.
File metadata
- Download URL: iso3901-0.3.3.tar.gz
- Upload date:
- Size: 18.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7888e5fc0dc01b1d7628ea1afd86334c619961255099d0d91518140b751bc33c |
|
MD5 | fb42353a3d5900150d925230725acadf |
|
BLAKE2b-256 | e4179bbccc20395d965259f9b93fbbe165c5755b172982e3edc24ecb0933585c |
Provenance
The following attestation bundles were made for iso3901-0.3.3.tar.gz
:
- Repository: Tagger-phile/py-iso3901
- Workflow: publish.yml
-
Statement type: https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
iso3901-0.3.3.tar.gz
- Subject digest:
7888e5fc0dc01b1d7628ea1afd86334c619961255099d0d91518140b751bc33c
- Transparency log index: 140175012
- Transparency log integration time:
- Predicate type:
File details
Details for the file iso3901-0.3.3-py3-none-any.whl
.
File metadata
- Download URL: iso3901-0.3.3-py3-none-any.whl
- Upload date:
- Size: 9.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68ae39bb16afbb974d72f496dacda6de191d5d3ece7e0d3fcf6797d1b61b346e |
|
MD5 | d7ed01217f43a1ae55c2140c804f7c70 |
|
BLAKE2b-256 | f7ec8b20380f92ff9f8660ca66b66ba8b42468aa6a1b3003023749a30c5bc15f |
Provenance
The following attestation bundles were made for iso3901-0.3.3-py3-none-any.whl
:
- Repository: Tagger-phile/py-iso3901
- Workflow: publish.yml
-
Statement type: https://in-toto.io/Statement/v1
- Predicate type:
https://docs.pypi.org/attestations/publish/v1
- Subject name:
iso3901-0.3.3-py3-none-any.whl
- Subject digest:
68ae39bb16afbb974d72f496dacda6de191d5d3ece7e0d3fcf6797d1b61b346e
- Transparency log index: 140175013
- Transparency log integration time:
- Predicate type: