%global _empty_manifest_terminate_build 0
Name: python-inifix
Version: 4.4.0
Release: 1
Summary: I/O facility for Idefix/Pluto configuration files
License: GPL-3.0
URL: https://github.com/neutrinoceros/inifix
Source0: https://mirrors.aliyun.com/pypi/web/packages/e5/e5/141211215a2ab5e0d67d5bd3da2502c302d4dd6fa4d66c4b83756e2d9041/inifix-4.4.0.tar.gz
BuildArch: noarch
Requires: python3-more-itertools
%description
# `inifix`
[](https://pypi.org/project/inifix/)
[](https://pypi.org/project/inifix/)
[](https://results.pre-commit.ci/badge/github/neutrinoceros/inifix/main.svg)
[](https://github.com/psf/black)
[](https://github.com/charliermarsh/ruff)
`inifix` is a small Python library of I/O functions to read and write 'ini'
configuration files in the style of [Pluto](http://plutocode.ph.unito.it) and
[Idefix](https://github.com/idefix-code/idefix).
While its primary goal is to follow Idefix's 'ini' format specification, it
supports a small superset of it.
The key differences are:
- `inifix` supports section-free definitions. This means configuration files
from [FARGO 3D](https://fargo3d.bitbucket.io) are also supported.
- in `inifix`, strings can be escaped using `'` or `"`. This allows to have
whitespaces in string values and to force string type decoding where numeric
and boolean types would work.
In rare cases where Idefix's 'ini' format doesn't match Pluto's, `inifix` will
follow the former. Known differences are:
- Idefix allows booleans to be written as `yes` and `no`.
- Idefix allows integers to be written using scientific notation (e.g. `1e3`)
## File format specifications details
Unroll !
- parameter names are strings
- names and values are separated by non-newline white spaces
- values are represented in unicode characters
- all values are considered numbers if possible (e.g., `1e3` is read as `1000`)
- number values are read as integers if no loss of precision ensues, and floats otherwise
- `true` and `false` (resp. `yes` and `no`) are cast to booleans (case-insensitive)
- values that can't be read as number or booleans are read as strings.
- string delimiters `"` and `'` can be used for strings containing whitespace, or to
force string type for values that would otherwise be read as numbers and booleans.
- a parameter can be associated to a single value or a list of whitespace-separated values
- sections titles start with `[` and end with `]`
- comments start with `#` and are ignored
A file is considered valid if calling `inifix.load()` doesn't raise an
error.
### Examples
The following content is considered valid
```ini
# My awesome experiment
[Grid]
x 1 2 u 10 # a comment
y 4 5 l 100
[Time Integrator]
CFL 1e-3
tstop 1E3
```
and maps to
```json
{
"Grid": {
"x": [1, 2, "u", 10],
"y": [4, 5, "l", 100]
},
"Time Integrator": {
"CFL": 0.001,
"tstop": 1000.0
}
}
```
The following section-less format doesn't comply to Pluto/Idefix's
specifications, but it is considered valid for inifix. This is the one
intentional differences in specifications, which makes inifix format a superset
of Pluto's inifile format.
```ini
mode fargo
# Time integrator
CFL 1e-3
tstop 1e3
```
and maps to
```json
{
"mode": "fargo",
"CFL": 0.001,
"tstop": 1000.0
}
```
Note that strings using e-notation (e.g. `1e-3` or `1E3` here) are decoded as
floats. Reversely, when writing files, floats are re-encoded using e-notation
if it leads to a more compact representation. For instance, `100000.0` is encoded
as `1e5`, but `189.0` is left unchanged because `1.89e2` takes one more character.
In cases where both reprensations are equally compact (e.g. `1.0` VS `1e0`),
decimal is prefered in encoding.
While decoding, `e` can be lower or upper case, but they are always encoded as
lower case.
Unroll !
- parameter names are strings
- names and values are separated by non-newline white spaces
- values are represented in unicode characters
- all values are considered numbers if possible (e.g., `1e3` is read as `1000`)
- number values are read as integers if no loss of precision ensues, and floats otherwise
- `true` and `false` (resp. `yes` and `no`) are cast to booleans (case-insensitive)
- values that can't be read as number or booleans are read as strings.
- string delimiters `"` and `'` can be used for strings containing whitespace, or to
force string type for values that would otherwise be read as numbers and booleans.
- a parameter can be associated to a single value or a list of whitespace-separated values
- sections titles start with `[` and end with `]`
- comments start with `#` and are ignored
A file is considered valid if calling `inifix.load()` doesn't raise an
error.
### Examples
The following content is considered valid
```ini
# My awesome experiment
[Grid]
x 1 2 u 10 # a comment
y 4 5 l 100
[Time Integrator]
CFL 1e-3
tstop 1E3
```
and maps to
```json
{
"Grid": {
"x": [1, 2, "u", 10],
"y": [4, 5, "l", 100]
},
"Time Integrator": {
"CFL": 0.001,
"tstop": 1000.0
}
}
```
The following section-less format doesn't comply to Pluto/Idefix's
specifications, but it is considered valid for inifix. This is the one
intentional differences in specifications, which makes inifix format a superset
of Pluto's inifile format.
```ini
mode fargo
# Time integrator
CFL 1e-3
tstop 1e3
```
and maps to
```json
{
"mode": "fargo",
"CFL": 0.001,
"tstop": 1000.0
}
```
Note that strings using e-notation (e.g. `1e-3` or `1E3` here) are decoded as
floats. Reversely, when writing files, floats are re-encoded using e-notation
if it leads to a more compact representation. For instance, `100000.0` is encoded
as `1e5`, but `189.0` is left unchanged because `1.89e2` takes one more character.
In cases where both reprensations are equally compact (e.g. `1.0` VS `1e0`),
decimal is prefered in encoding.
While decoding, `e` can be lower or upper case, but they are always encoded as
lower case.
Unroll !
- parameter names are strings
- names and values are separated by non-newline white spaces
- values are represented in unicode characters
- all values are considered numbers if possible (e.g., `1e3` is read as `1000`)
- number values are read as integers if no loss of precision ensues, and floats otherwise
- `true` and `false` (resp. `yes` and `no`) are cast to booleans (case-insensitive)
- values that can't be read as number or booleans are read as strings.
- string delimiters `"` and `'` can be used for strings containing whitespace, or to
force string type for values that would otherwise be read as numbers and booleans.
- a parameter can be associated to a single value or a list of whitespace-separated values
- sections titles start with `[` and end with `]`
- comments start with `#` and are ignored
A file is considered valid if calling `inifix.load()` doesn't raise an
error.
### Examples
The following content is considered valid
```ini
# My awesome experiment
[Grid]
x 1 2 u 10 # a comment
y 4 5 l 100
[Time Integrator]
CFL 1e-3
tstop 1E3
```
and maps to
```json
{
"Grid": {
"x": [1, 2, "u", 10],
"y": [4, 5, "l", 100]
},
"Time Integrator": {
"CFL": 0.001,
"tstop": 1000.0
}
}
```
The following section-less format doesn't comply to Pluto/Idefix's
specifications, but it is considered valid for inifix. This is the one
intentional differences in specifications, which makes inifix format a superset
of Pluto's inifile format.
```ini
mode fargo
# Time integrator
CFL 1e-3
tstop 1e3
```
and maps to
```json
{
"mode": "fargo",
"CFL": 0.001,
"tstop": 1000.0
}
```
Note that strings using e-notation (e.g. `1e-3` or `1E3` here) are decoded as
floats. Reversely, when writing files, floats are re-encoded using e-notation
if it leads to a more compact representation. For instance, `100000.0` is encoded
as `1e5`, but `189.0` is left unchanged because `1.89e2` takes one more character.
In cases where both reprensations are equally compact (e.g. `1.0` VS `1e0`),
decimal is prefered in encoding.
While decoding, `e` can be lower or upper case, but they are always encoded as
lower case.