Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeblackwaslike/hashidtools
HashID tools/components for async ID generation
https://github.com/joeblackwaslike/hashidtools
Last synced: about 2 months ago
JSON representation
HashID tools/components for async ID generation
- Host: GitHub
- URL: https://github.com/joeblackwaslike/hashidtools
- Owner: joeblackwaslike
- License: mit
- Created: 2018-05-12T08:00:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-05-12T08:19:53.000Z (over 6 years ago)
- Last Synced: 2024-08-10T08:49:25.593Z (5 months ago)
- Language: Python
- Size: 17.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# HashIDTools
[](https://travis-ci.org/joeblackwaslike/hashidtools) [](https://github.com/joeblackwaslike/hashidtools) [](https://pypi.python.org/pypi/hashidtools) [](https://pypi.python.org/pypi/hashidtools) [](https://pypi.python.org/pypi/hashidtools) [](https://pypi.python.org/pypi/hashidtools)
## Maintainer
Joe Black | | [github](https://github.com/joeblackwaslike)
## Introduction
HashID tools/components for async ID generation. Example: `k62K3zOn4Y5Kkxmg7pWOAqPyd8NVjrmX` Designed for async data model ID generation for persisting objects to a graph DB such as ZODB. ZCA means it's simple to customize and override without editing any code.
#### Comes with
* Customizable Generator/encoder/decoder utility
* Type class (experimental)
* Persistent, 2x BTree-powered IntID/Ref Manager
* Custom fields for `zope.schema` and `attrs`, with default factory functions, validation, etc.
#### Also
* Random seed integer is just under 64bits.
* Derive seed integer at any time by casting type as an int.
## Installation
```shell
pip3 install hashidtools
```
## Usage
### HashIDGenerator
```python
>>> from hashidtools import HashIDGenerator
>>> gen = HashIDGenerator(salt='my random salt', min_length=32)
>>> gen.seed()
...
>>> gen
HashIDGenerator(salt='my random salt', min_length=32)
>>> gen.new()
'...'
>>> gen.decode(gen.new())
...
```
### HashID Type
```python
>>> from hashidtools import HashID
... HashID()
'...'
>>> HashID('8nKqkABjlYB5A7430M917zAJao1Me4mN')
'8nKqkABjlYB5A7430M917zAJao1Me4mN'
```
### Hashid IntID Indexing & Event System
```python
>>> intid = HashIDManager()
... intid
HashIDManager(attribute='id')
... intid.generateId()
'...'
>>> from zc.intid.interfaces import AddedEvent, RemovedEvent
... import zope.event.classhandler
...
>>> @zope.event.classhandler.handler(AddedEvent)
... def handler(event):
... print(event.id, event.object, event.idmanager)
...
... @zope.event.classhandler.handler(RemovedEvent)
... def handler(event):
... print(event.id, event.object, event.idmanager)
>>> import attr
... Test = attr.make_class(
... 'Test', {'id': fields.hashid(init=False),
... 'name': attr.ib(default='default-name')})
...
>>> t = Test()
... intid.register(t)
'...'
... id = intid.getId(t)
... intid.getObject(id)
Test(id='...', name='default-name')
>>> intid.unregister(t)
```
### Retrieving the utilities through the ZCA Registry
```python
>>> from zope.component import queryUtility
... from hashidtools.interfaces import IHashIDGenerator, IIntIds
...
... queryUtility(IHashIDGenerator)
HashIDGenerator(salt='$2a$12$AAAAAAAAAAAAAACgpDEPGQ', min_length=32)
>>> queryUtility(IIntIds)
HashIDs(attribute='id')
```
### Extending this Package
This package uses Zope Component Architecture for the ultimate in pluggable extendibility.
#### Quick example of customizing the HashID Generator:
```python
# Note: you can also create your own Generator class that implements the
# IHashIDGenerator interface and register it.
from zope.component import provideUtility
from hashidtools import HashIDGenerator
from hashidtools.interfaces import IHashIDGenerator
generator = HashIDGenerator(**custom_options)
provideUtility(generator, IHashIDGenerator)
```
Note: the following would preferrably be done using your project's ZCML directives.
## Changes
* [CHANGELOG](CHANGELOG.md)