Python library for Java .properties file parsing
Project description
python-jproperties
==================
[![Build Status](https://travis-ci.org/translate/python-jproperties.svg)](https://travis-ci.org/translate/python-jproperties)
A python library for parsing and handling Java .properties files.
Installation
------------
```
$ pip install jproperties3
```
Test
----
```
$ python setup.py test
```
Build
-----
```
$ python setup.py build
```
Usage
-----
A Properties object is, on the outside, a simple key-value store.
Initialize it as such:
```python
from jproperties import Properties
p = Properties()
# Or with default values:
p2 = Properties({"foo": "bar"})
print(p2["foo"])
```
The usual dictionary interfaces are available:
```python
p2["key"] = "value"
for key in p2.keys():
print(key, p2[key])
```
Note that keys and values are all expected to be and be treated as strings.
To serialize the object into the .properties format, turn it into a string:
```python
with open("out.properties", "w") as f:
f.write(str(p2))
```
To read an existing properties file, create the instance using the `stream`
keyword parameter
```python
with open("out.properties", "r") as f:
p = Properties(stream=f)
```
Note that comments and blank lines are loaded into the Properties object's
nodes when using load(), and will be serialized in str().
If comments and blank lines are unimportant and you want to get rid of them,
you can create a new Properties object from an existing one's keys:
```python
p3 = Properties(p2.keys())
```
### License
This project is licensed under the MIT license. The full license text is
available in the LICENSE file.
==================
[![Build Status](https://travis-ci.org/translate/python-jproperties.svg)](https://travis-ci.org/translate/python-jproperties)
A python library for parsing and handling Java .properties files.
Installation
------------
```
$ pip install jproperties3
```
Test
----
```
$ python setup.py test
```
Build
-----
```
$ python setup.py build
```
Usage
-----
A Properties object is, on the outside, a simple key-value store.
Initialize it as such:
```python
from jproperties import Properties
p = Properties()
# Or with default values:
p2 = Properties({"foo": "bar"})
print(p2["foo"])
```
The usual dictionary interfaces are available:
```python
p2["key"] = "value"
for key in p2.keys():
print(key, p2[key])
```
Note that keys and values are all expected to be and be treated as strings.
To serialize the object into the .properties format, turn it into a string:
```python
with open("out.properties", "w") as f:
f.write(str(p2))
```
To read an existing properties file, create the instance using the `stream`
keyword parameter
```python
with open("out.properties", "r") as f:
p = Properties(stream=f)
```
Note that comments and blank lines are loaded into the Properties object's
nodes when using load(), and will be serialized in str().
If comments and blank lines are unimportant and you want to get rid of them,
you can create a new Properties object from an existing one's keys:
```python
p3 = Properties(p2.keys())
```
### License
This project is licensed under the MIT license. The full license text is
available in the LICENSE file.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for jproperties3-0.5.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 015ac509a85d8d9af9dca0d82383f58c1827c8bce4b9b105da36504467f81f9d |
|
MD5 | 4318d74b396f4b0fbab96ef24a3aa63f |
|
BLAKE2b-256 | 9df46f30e3d98eaadf6994d85dfb1f57dca63d7e76319a9d34e8807fb50facf9 |