Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laike9m/ezcf
Import configuration file for Pythonista
https://github.com/laike9m/ezcf
Last synced: about 1 month ago
JSON representation
Import configuration file for Pythonista
- Host: GitHub
- URL: https://github.com/laike9m/ezcf
- Owner: laike9m
- License: mit
- Archived: true
- Created: 2015-03-07T07:06:53.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-10-04T06:07:15.000Z (about 5 years ago)
- Last Synced: 2024-10-29T23:34:04.410Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 298 KB
- Stars: 158
- Watchers: 14
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - laike9m/ezcf - Import configuration file for Pythonista (Python)
README
# ezcf
[](https://travis-ci.org/laike9m/ezcf)
[](https://pypi.python.org/pypi/ezcf/)
[](http://badge.fury.io/py/ezcf)
[](https://coveralls.io/r/laike9m/ezcf)
ezcf stands for **easy configuration**, it allows you to import JSON/YAML/INI/XML
like .py files. It is useful whenever you need to read from these formats,
especially for reading configuration files.
OK, stop talking, show us some code!
On the left is what you'll normally do, on the right is the ezcf way.
**All you need is `import ezcf` first, then `import filename` without extension.** Nothing else!
For instance, here we want to load file `config.json`. With a single line of code `from config import *`,
everything is done and you're happy.
## Install
pip install ezcf
If you run into `error: yaml.h: No such file or directory`, don't worry,
you can still use ezcf without any problem.
## Supported File Types
ezcf supports `JSON`, `YAML`, `INI` and `XML` with extension `json`, `yaml`, `yml`, `ini`, `xml`.
## Sample Usage
Let's start with an easy case:
```
├── sample1.py
└── sample1.json
```
`sample1.py` and `sample1.json` are in the same directory. We want to read `sample1.json` in `sample1.py`, here's how:
```python
"""
# sample1.json
{
"hello": "world"
}
"""
# sample1.py
import ezcf
from sample1 import hello
print(hello) # 'world'
```
It's that easy.
That's cool, but we usually put config files in a separate folder. Can ezcf deal with that?
```
├── conf
│ ├── __init__.py
│ └── sample2.yaml
└── sample2.py
```
Why not?
```python
"""sample2.yaml
---
Time: 2001-11-23 15:02:31 -5
User: ed
warning:
This is a warning.
---
Stack:
- file: TopClass.py
line: 23
code: |
x = MoreObject("345\n")
- file: MoreClass.py
line: 58
code: |-
foo = bar
"""
# sample2.py
import ezcf
from conf.sample2 import Time, User, warning, Stack
Time # datetime.datetime(2001, 11, 23, 20, 2, 31)
User # ed
warning # This is a warning.
Stack # [{'line': 23, 'code': 'x = MoreObject("345\\n")\n', 'file': 'TopClass.py'}, {'line': 58, 'code': 'foo = bar', 'file': 'MoreClass.py'}]
```
ezcf supports all kinds of valid import statements. These statements are equivalent:
```python
from conf.sample2 import Time, User, warning, Stack
from conf.sample2 import *
import conf.sample2 # then use conf.sample2.Time/User/warning/Stack
import conf.sample2 as cs # then use cs.Time/User/warning/Stack
```
In a word, you can assume they're just regular python files.(Currently ezcf only supports files with utf-8 encoding)
What about relative import? Yes, ezcf supports relative import, as long as you use it *correctly*.
## Note
1. Be careful importing YAML which contains multiple documents: if there exists keys with the same name,
only one of them will be loaded. So it's better not to use multiple documents;
2. All values in `.ini` files are kept as it is and loaded as a string;
3. Since XML only allows single root, the whole xml will be loaded as one dict with root's name as variable name;
4. Use [**valid variable names**][1], this means key strings in JSON/YAML/INI/XML should be valid Python variable name.
Invalid variable name won't do any harm to your program nor will it crash, but you can't use them as expected.
## Run Tests
```
python setup.py test
```
## Roadmap
- [x] Use dot to seperate folder/subfolder/file
- [x] Unicode support
- [x] JSON support
- [x] YAML support
- [x] INI support
- [x] XML support
- [ ] Auto encoding detect?
- [x] CI
- [x] coverage
- [x] pypi
## License
MIT
[1]: https://docs.python.org/3.4/reference/lexical_analysis.html#identifiers