معرفی شرکت ها
biconfigs-0.1.3
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Two way configurations mapping helper for Python.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | biconfigs-0.1.3 |
| نام | biconfigs |
| نسخه کتابخانه | 0.1.3 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Anthony Fu |
| ایمیل نویسنده | anthonyfu117@hotmail.com |
| آدرس صفحه اصلی | https://github.com/antfu/biconfigs |
| آدرس اینترنتی | https://pypi.org/project/biconfigs/ |
| مجوز | MIT |
Biconfigs
=========
|Build Status| |Coverage| |Codacy grade| |Python Version| |PyPI| |PyPI
Status| |License|
📄⇄🛠 Two way configurations mapping helper for Python.
Get Started
-----------
.. code:: python
from biconfigs import Biconfigs
configs = Biconfigs('configs.json')
# Simply change the dict, and it will automatically save the changes to file.
configs['options'] = {'debug': True,
'username': 'Anthony',
'list': [] }
# Access with simple 'x.y.z' style
configs.options.list.append('example')
Content of file ``configs.json`` after execution:
.. code:: json
{
"options": {
"debug": true,
"list": [
"example"
],
"username": "Anthony"
}
}
\* *Biconfigs also supports `CSON <#cson>`__ and `YAML <#yaml>`__ file
formats.*
Install
-------
.. code:: sh
pip install biconfigs
Dependencies
------------
**No dependencies** required 🎉
Tested on Python ``2.6``, ``2.7``, ``3.3``, ``3.4``, ``3.5``, ``pypy``,
``pypy3``
Documentation
-------------
When to save
~~~~~~~~~~~~
- Saving when: *Item create, item delete, list reorder, value change,
``setdefault``, etc.*
.. code:: python
# All the following single statement will cause saving
configs['item'] = 'value'
configs['options'] = {}
configs.options['list'] = []
configs.options.list.append('example')
configs.options['list'] = []
configs.options.clear()
value2 = configs.setdefault('item2', 45)
- Not saving when: *Item access, assignment but not changed, etc.*
.. code:: python
# All the following single statement will NOT cause saving
value = configs.item
configs['item'] = 'value' # The value of 'item' is not changed
value3 = configs.get('item_not_exists', 'default_value')
Non-blocking saving
~~~~~~~~~~~~~~~~~~~
By default, Biconfigs use asynchronous saving. You can disable the
feature by setting ``async_write`` to ``False``
.. code:: python
# set "async_write=False" if your want to use synchronous saving
# to ensure your data saved to file in time,
# WARNING: In sync mode, your changes will block the incoming statement
# until the file correctly saved.
configs = Biconfigs('configs.json', async_write=False)
configs['item'] = 'value' # Blocking
# Configure file saved already
# Your code...
High frequency update
~~~~~~~~~~~~~~~~~~~~~
Normally, Biconfigs will write the changes to file immediately. But
sometime you may want to update values frequently, which will result in
a IO bottleneck. So you can use **``with``** statement to prevent auto
saving for a while.
.. code:: python
with configs:
for i in range(1000):
configs['some_key'] = i
# This statement will execute saving process only one time when exiting "with" scope
Reload from file
~~~~~~~~~~~~~~~~
Simply use ``reload`` function to reload from file. *Note*: ``reload``
will discard all present data in Biconfigs-object and loads new ones
from file)
.. code:: python
configs.reload()
Parsers
~~~~~~~
Biconfigs use ``Prettified Json`` as default parser. You may want to set
``parser='json'`` to save as compacted json file.
.. code:: python
configs = Biconfigs('configs.json', parser='json')
configs['item'] = 'value'
configs['debug'] = False
configs.json:
.. code:: json
{"debug": false, "item": "value"}
**Available Parsers**
- ``json``: Compact JSON format
- ``pretty-json``: Prettified JSON
- ``cson``: CSON format, refer to `CSON <#cson>`__
- ``yaml``: YAML format, refer to `YAML <#yaml>`__
CSON
----
Biconfigs supports `CSON <https://github.com/bevry/cson>`__ by
`avakar/pycson <https://github.com/avakar/pycson>`__
.. code:: python
from biconfigs import Biconfigs
from biconfigs import parser_cson
configs = Biconfigs('configs.cson', parser='cson')
# Then use biconfigs as you normally would...
**Extra requirements**
To use CSON, you need to install extra requirement
.. code:: sh
pip install biconfigs[cson]
Or install ``cson`` manually:
.. code:: sh
pip install cson
**CSON problems**
Please check `avakar/pycson: The
Language <https://github.com/avakar/pycson#the-language>`__
YAML
----
Biconfigs supports `YAML <http://yaml.org/>`__ by
`PyYAML <http://pyyaml.org/>`__
.. code:: python
from biconfigs import Biconfigs
from biconfigs import parser_yaml
configs = Biconfigs('configs.yml', parser='yaml')
# Then use biconfigs as you normally would...
**Extra requirements**
To use YAML, you need to install extra requirement
.. code:: sh
pip install biconfigs[yaml]
Or install ``PyYAML`` manually:
.. code:: sh
pip install PyYAML
License
-------
MIT
.. |Build Status| image:: https://img.shields.io/travis/antfu/biconfigs.svg?style=flat-square
:target: https://travis-ci.org/antfu/biconfigs
.. |Coverage| image:: https://img.shields.io/codecov/c/github/antfu/biconfigs.svg?style=flat-square
:target: https://codecov.io/gh/antfu/biconfigs
.. |Codacy grade| image:: https://img.shields.io/codacy/grade/4bf188eecc374c76b5c6ddbe93315078.svg?style=flat-square
:target: https://www.codacy.com/app/anthonyfu117/biconfigs/dashboard
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/biconfigs.svg?style=flat-square
:target: https://pypi.python.org/pypi/biconfigs
.. |PyPI| image:: https://img.shields.io/pypi/v/biconfigs.svg?style=flat-square
:target: https://pypi.python.org/pypi/biconfigs
.. |PyPI Status| image:: https://img.shields.io/pypi/status/biconfigs.svg?style=flat-square
:target: https://pypi.python.org/pypi/biconfigs
.. |License| image:: https://img.shields.io/pypi/l/biconfigs.svg?style=flat-square
:target: https://github.com/antfu/biconfigs/blob/master/LICENSE
نحوه نصب
نصب پکیج whl biconfigs-0.1.3:
pip install biconfigs-0.1.3.whl
نصب پکیج tar.gz biconfigs-0.1.3:
pip install biconfigs-0.1.3.tar.gz