https://github.com/machu-gwu/constant2-project
provide extensive way of managing your constant variable.
https://github.com/machu-gwu/constant2-project
configuration constants data developer-tools python
Last synced: 10 days ago
JSON representation
provide extensive way of managing your constant variable.
- Host: GitHub
- URL: https://github.com/machu-gwu/constant2-project
- Owner: MacHu-GWU
- License: mit
- Created: 2017-05-19T06:02:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-12-03T21:37:10.000Z (over 5 years ago)
- Last Synced: 2025-02-21T11:47:56.509Z (over 1 year ago)
- Topics: configuration, constants, data, developer-tools, python
- Language: Python
- Size: 310 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
.. image:: https://github.com/MacHu-GWU/constant2-project/workflows/CI/badge.svg
:target: https://github.com/MacHu-GWU/constant2-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/constant2-project/branch/master/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/constant2-project
.. image:: https://img.shields.io/pypi/v/constant2.svg
:target: https://pypi.python.org/pypi/constant2
.. image:: https://img.shields.io/pypi/l/constant2.svg
:target: https://pypi.python.org/pypi/constant2
.. image:: https://img.shields.io/pypi/pyversions/constant2.svg
:target: https://pypi.python.org/pypi/constant2
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/constant2-project
------
.. image:: https://img.shields.io/badge/Link-Document-blue.svg
:target: http://constant2.my-docs.com/index.html
.. image:: https://img.shields.io/badge/Link-API-blue.svg
:target: http://constant2.my-docs.com/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg
:target: http://constant2.my-docs.com/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Install-blue.svg
:target: `install`_
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/constant2-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/constant2-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/constant2-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/constant2#files
Welcome to ``constant2`` Documentation
==============================================================================
If you have lots of constant2 value widely used across your development. A better way is to define ``Constantant Variable`` rather than using the raw value. This can improve the readability and accessibility.
``constant2`` is a library provide extensive way of managing your constant2 variable.
**Another powerful feature** is, ``constant2`` allows developer defines normalized entity relationship and is data in ``class`` style, which giving awesome accessibility to every single row, and every single column, free developer from memorizing things.
Usage
------------------------------------------------------------------------------
**Version Changed 0.0.9: All nested class now has to inherit from** ``Constant`` **or its subclass**:
.. code-block:: python
# WRONG!
class ItemType(Constant):
class Weapon:
id = 1
# CORRECT
class ItemType(Constant):
class Weapon(Constant):
id = 1
# or
class Item(Constant):
pass
class ItemType(Constant):
class Weapon(Item):
id = 1
Usage:
.. code-block:: python
from constant2 import Constant
class Food(Constant):
class Fruit(Constant):
id = 1
name = "fruit"
class Apple(Constant):
id = 1
name = "apple"
class RedApple(Constant):
id = 1
name = "red apple"
class GreenApple(Constant):
id = 2
name = "green apple"
class Banana(Constant):
id = 2
name = "banana"
class YellowBanana(Constant):
id = 1
name = "yellow banana"
class GreenBanana(Constant):
id = 2
name = "green banana"
class Meat(Constant):
id = 2
name = "meat"
class Pork(Constant):
id = 1
name = "pork"
class Beef(Constant):
id = 2
name = "beef"
food = Food()
You can visit it's data or child class data in these way:
.. code-block:: python
# Use class
>>> Fruit.Items() # .Items() return it's data
[('id', 1), ('name', 'fruit')]
>>> Fruit.Keys() # .Keys() return keys
['id', 'name']
>>> Fruit.Values() # .Values() return values
[1, 'fruit']
>>> Fruit.ToDict() # return data in a dict
{'id': 1, 'name': 'fruit'}
# use instance
>>> food.items() # .Items() return it's data
[('id', 1), ('name', 'fruit')]
>>> food.keys() # .keys() return keys
['id', 'name']
>>> food.values() # .values() return values
[1, 'fruit']
>>> food.to_dict() # return data in a dict
{'id': 1, 'name': 'fruit'}
# iterate on all nested class
>>> Fruit.Subclasses(sort_by='id')
[class Apple, class Banana]
# get first nested class that kls.id == 1
# useful when you need reverse lookup
>>> Fruit.GetFirst('id', 1)
class Apple
# get all child class that kls.id == 1
>>> Fruit.GetAll('id', 1)
[class Apple, ]
And it provides built-in I/O methods allow you to dump these data in to a dictionary.
.. code-block:: python
>>> data = Food.dump()
>>> data
{
"Food": {
"Fruit": {
"Apple": {
"GreenApple": {
"__classname__": "GreenApple",
"id": 2,
"name": "green apple"
},
"RedApple": {
"__classname__": "RedApple",
"id": 1,
"name": "red apple"
},
"__classname__": "Apple",
"id": 1,
"name": "apple"
},
"Banana": {
"GreenBanana": {
"__classname__": "GreenBanana",
"id": 2,
"name": "green banana"
},
"YellowBanana": {
"__classname__": "YellowBanana",
"id": 1,
"name": "yellow banana"
},
"__classname__": "Banana",
"id": 2,
"name": "banana"
},
"__classname__": "Fruit",
"id": 1,
"name": "fruit"
},
"Meat": {
"Beef": {
"__classname__": "Beef",
"id": 2,
"name": "beef"
},
"Pork": {
"__classname__": "Pork",
"id": 1,
"name": "pork"
},
"__classname__": "Meat",
"id": 2,
"name": "meat"
},
"__classname__": "Food"
}
}
>>> Food = Constant.load(data)
.. _install:
Install
------------------------------------------------------------------------------
``constant2`` is released on PyPI, so all you need is:
.. code-block:: console
$ pip install constant2
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade constant2