IDKit 1.0.0

A typed, dot-notation identifier system for Python 3.12+.

IDKit

A small typed identifier system for Python 3.12+.

It lets you build structured identifiers using dot notation:

from idkit import ID

identifier = ID.system.runtime.agent.analyzer

print(identifier)
# system::runtime-agent+analyzer

print(identifier.namespace)
# system::runtime-agent

print(identifier.path)
# system/runtime/agent/analyzer

print(identifier.slug)
# system-runtime-agent-analyzer

Format

Group::Source[-Component][+Role]

Examples:

system::runtime
system::runtime-agent
system::runtime-agent+analyzer
service::data-resource+ingester
manage::workflow-pipeline+runner

Type aliases

from idkit import IDKitIdentifier, IDKitIdentifierLike, IDKitIdentifiable

Use IDKitIdentifier when you want the concrete implementation.

Use IDKitIdentifierLike when your function only needs the public identifier interface.

Use IDKitIdentifiable when your object exposes an .identifier property.

Compatibility aliases are also exported:

from idkit import AppIdentifier, AppIdentifierLike, AppIdentifiable

def register(identifier: IDKitIdentifierLike) -> None:
    identifier.require_complete()
    print(identifier.value)

Installation

pip install idkit

Parsing

parsed = ID.parse("system::runtime-agent+analyzer")

assert parsed == ID.system.runtime.agent.analyzer

Matching

identifier = ID.system.runtime.agent.analyzer

identifier.matches(ID.system)
# True

identifier.matches(ID.system.runtime)
# True

identifier.matches(ID.system.runtime.agent)
# True

identifier.matches(ID.service)
# False

Parent traversal

identifier = ID.system.runtime.agent.analyzer

identifier.parent
# Identifier('system::runtime-agent')

identifier.parent.parent
# Identifier('system::runtime')

identifier.parent.parent.parent
# Identifier('system')

Development

Run tests:

python3 -m pytest