Codebase list javaproperties / fb4bec6b-29a6-4c0f-804b-690ea879d8a6/main
fb4bec6b-29a6-4c0f-804b-690ea879d8a6/main

Tree @fb4bec6b-29a6-4c0f-804b-690ea879d8a6/main (Download .tar.gz) 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
.. image:: http://www.repostatus.org/badges/latest/active.svg
    :target: http://www.repostatus.org/#active
    :alt: Project Status: Active - The project has reached a stable, usable
          state and is being actively developed.

.. image:: https://travis-ci.org/jwodder/javaproperties.svg?branch=master
    :target: https://travis-ci.org/jwodder/javaproperties

.. image:: https://codecov.io/gh/jwodder/javaproperties/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/jwodder/javaproperties

.. image:: https://img.shields.io/pypi/pyversions/javaproperties.svg
    :target: https://pypi.org/project/javaproperties

.. image:: https://img.shields.io/github/license/jwodder/javaproperties.svg?maxAge=2592000
    :target: https://opensource.org/licenses/MIT
    :alt: MIT License

.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
    :target: https://saythanks.io/to/jwodder

`GitHub <https://github.com/jwodder/javaproperties>`_
| `PyPI <https://pypi.org/project/javaproperties>`_
| `Documentation <https://javaproperties.readthedocs.io>`_
| `Issues <https://github.com/jwodder/javaproperties/issues>`_
| `Changelog <https://github.com/jwodder/javaproperties/blob/master/CHANGELOG.md>`_

``javaproperties`` provides support for reading & writing |properties|_ (both
the simple line-oriented format and XML) with a simple API based on the
``json`` module — though, for recovering Java addicts, it also includes a
``Properties`` class intended to match the behavior of |propclass|_ as much as
is Pythonically possible.

Previous versions of ``javaproperties`` included command-line programs for
basic manipulation of ``.properties`` files.  As of version 0.4.0, these
programs have been split off into a separate package, |clipkg|_.


Installation
============

Just use `pip <https://pip.pypa.io>`_ (You have pip, right?) to install
``javaproperties`` and its dependencies::

    pip install javaproperties


Examples
========

Dump some keys & values (output order not guaranteed)::

    >>> properties = {"key": "value", "host:port": "127.0.0.1:80", "snowman": "☃", "goat": "🐐"}
    >>> print(javaproperties.dumps(properties))
    #Mon Sep 26 14:57:44 EDT 2016
    key=value
    goat=\ud83d\udc10
    host\:port=127.0.0.1\:80
    snowman=\u2603

Load some keys & values::

    >>> javaproperties.loads('''
    ... #Mon Sep 26 14:57:44 EDT 2016
    ... key = value
    ... goat: \\ud83d\\udc10
    ... host\\:port=127.0.0.1:80
    ... #foo = bar
    ... snowman   ☃
    ... ''')
    {'goat': '🐐', 'host:port': '127.0.0.1:80', 'key': 'value', 'snowman': '☃'}

Dump some properties to a file and read them back in again::

    >>> with open('example.properties', 'w', encoding='latin-1') as fp:
    ...     javaproperties.dump(properties, fp)
    ...
    >>> with open('example.properties', 'r', encoding='latin-1') as fp:
    ...     javaproperties.load(fp)
    ...
    {'goat': '🐐', 'host:port': '127.0.0.1:80', 'key': 'value', 'snowman': '☃'}

Sort the properties you're dumping::

    >>> print(javaproperties.dumps(properties, sort_keys=True))
    #Mon Sep 26 14:57:44 EDT 2016
    goat=\ud83d\udc10
    host\:port=127.0.0.1\:80
    key=value
    snowman=\u2603

Turn off the timestamp::

    >>> print(javaproperties.dumps(properties, timestamp=None))
    key=value
    goat=\ud83d\udc10
    host\:port=127.0.0.1\:80
    snowman=\u2603

Use your own timestamp (automatically converted to local time)::

    >>> print(javaproperties.dumps(properties, timestamp=1234567890))
    #Fri Feb 13 18:31:30 EST 2009
    key=value
    goat=\ud83d\udc10
    host\:port=127.0.0.1\:80
    snowman=\u2603

Dump as XML::

    >>> print(javaproperties.dumps_xml(properties))
    <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
    <properties>
    <entry key="key">value</entry>
    <entry key="goat">🐐</entry>
    <entry key="host:port">127.0.0.1:80</entry>
    <entry key="snowman">☃</entry>
    </properties>

New in v0.6.0: Dump Unicode characters as-is instead of escaping them::

    >>> print(javaproperties.dumps(properties, ensure_ascii=False))
    #Tue Feb 25 19:13:27 EST 2020
    key=value
    goat=🐐
    host\:port=127.0.0.1\:80
    snowman=☃

`And more! <https://javaproperties.readthedocs.io>`_


.. |properties| replace:: Java ``.properties`` files
.. _properties: https://en.wikipedia.org/wiki/.properties

.. |propclass| replace:: Java 8's ``java.util.Properties``
.. _propclass: https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html

.. |clipkg| replace:: ``javaproperties-cli``
.. _clipkg: https://github.com/jwodder/javaproperties-cli

Commit History @fb4bec6b-29a6-4c0f-804b-690ea879d8a6/main