معرفی شرکت ها
commented-configparser-1.0.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Custom ConfigParser class that preserves comments in file when writing
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | commented-configparser-1.0.0 |
| نام | commented-configparser |
| نسخه کتابخانه | 1.0.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | Preocts <preocts@preocts.com> |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/commented-configparser/ |
| مجوز | MIT License Copyright (c) 2022 Preocts Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
[](https://www.python.org/downloads)
[](https://github.com/psf/black)
[](https://github.com/pre-commit/pre-commit)
[](https://results.pre-commit.ci/latest/github/Preocts/commented-configparser/main)
[](https://github.com/Preocts/commented-configparser/actions/workflows/python-tests.yml)
# commented-configparser
A custom ConfigParser class that preserves comments when writing loaded config out.
This library gives you a custom class of the standard library's `configparser.ConfigParger` which will preserve the comments of a loaded config file when writing that file back out.
---
## Install via pip
From pypi:
```bash
python -m pip install commented-configparser
```
From github:
```bash
python -m pip install commented-configparser@git+https://github.com/Preocts/commented-configparser@main
```
**Note:** Replace `main` with the desired tag or branch. This can be placed in a `requirements.txt` file as well.
---
## Example use
```py
from commentedconfigparser import CommentedConfigParser
# Load the config like normal
config = CommentedConfigParser()
config.read("myconfig.ini")
# Use the config like normal
...
# Update the config like normal
...
# Save the config back to the file
with open("myconfig.ini", "w") as savefile:
config.write(savefile)
```
## Results
We favor the line spacing choices of the `ConfigParser` class so the input format may not be preserved completely. However, the comments will be preserved.
### Before
```ini
# Welcome to our config
[DEFAULT]
# This value has some meaning to someone
foo=bar
# Make sure to add this when you need it
trace=false
logging=true
; This is a comment as well
# so we need to track all of them
; and many could be between things
[NEW SECTION]
# Another comment
multi-line=
value01
value02
value03
closing=0
# Trailing comment
```
### After
```ini
# Welcome to our config
[DEFAULT]
# This value has some meaning to someone
foo=bar
# Make sure to add this when you need it
trace=false
logging=true
; This is a comment as well
# so we need to track all of them
; and many could be between things
[NEW SECTION]
# Another comment
multi-line=
value01
value02
value03
closing=0
# Trailing comment
```
---
# Local developer installation
It is **strongly** recommended to use a virtual environment
([`venv`](https://docs.python.org/3/library/venv.html)) when working with python
projects. Leveraging a `venv` will ensure the installed dependency files will
not impact other python projects or any system dependencies.
The following steps outline how to install this repo for local development. See
the [CONTRIBUTING.md](CONTRIBUTING.md) file in the repo root for information on
contributing to the repo.
**Windows users**: Depending on your python install you will use `py` in place
of `python` to create the `venv`.
**Linux/Mac users**: Replace `python`, if needed, with the appropriate call to
the desired version while creating the `venv`. (e.g. `python3` or `python3.8`)
**All users**: Once inside an active `venv` all systems should allow the use of
`python` for command line instructions. This will ensure you are using the
`venv`'s python and not the system level python.
---
## Installation steps
Clone this repo and enter root directory of repo:
```console
$ git clone https://github.com/Preocts/commented-configparser
$ cd commented-configparser
```
Create the `venv`:
```console
$ python -m venv venv
```
Activate the `venv`:
```console
# Linux/Mac
$ . venv/bin/activate
# Windows
$ venv\Scripts\activate
```
The command prompt should now have a `(venv)` prefix on it. `python` will now
call the version of the interpreter used to create the `venv`
Install editable library and development requirements:
```console
# Update pip and tools
$ python -m pip install --upgrade pip
# Install editable version of library
$ python -m pip install --editable .[dev]
```
Install pre-commit [(see below for details)](#pre-commit):
```console
$ pre-commit install
```
---
## Misc Steps
Run pre-commit on all files:
```console
$ pre-commit run --all-files
```
Run tests:
```console
$ tox [-r] [-e py3x]
```
Build dist:
```console
$ python -m pip install --upgrade build
$ python -m build
```
To deactivate (exit) the `venv`:
```console
$ deactivate
```
---
## Note on flake8:
`flake8` is included in the `requirements-dev.txt` of the project. However it
disagrees with `black`, the formatter of choice, on max-line-length and two
general linting errors. `.pre-commit-config.yaml` is already configured to
ignore these. `flake8` doesn't support `pyproject.toml` so be sure to add the
following to the editor of choice as needed.
```ini
--ignore=W503,E203
--max-line-length=88
```
---
## [pre-commit](https://pre-commit.com)
> A framework for managing and maintaining multi-language pre-commit hooks.
This repo is setup with a `.pre-commit-config.yaml` with the expectation that
any code submitted for review already passes all selected pre-commit checks.
`pre-commit` is installed with the development requirements and runs seemlessly
with `git` hooks.
---
## Makefile
This repo has a Makefile with some quality of life scripts if the system
supports `make`. Please note there are no checks for an active `venv` in the
Makefile.
| PHONY | Description |
| ------------- | -------------------------------------------------------------------------- |
| `init` | Update pip to newest version |
| `install` | install the project |
| `install-dev` | install development/test requirements and project as editable install |
| `upgrade-dev` | update all dependencies, regenerate requirements.txt (disabled by default) |
| `build-dist` | Build source distribution and wheel distribution |
| `clean` | Deletes build, tox, coverage, pytest, mypy, cache, and pyc artifacts |
نیازمندی
| مقدار | نام |
|---|---|
| - | pre-commit |
| - | black |
| - | mypy |
| - | flake8 |
| - | flake8-builtins |
| - | flake8-pep585 |
| - | pytest |
| - | pytest-randomly |
| - | coverage |
| - | tox |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7 | Python |
نحوه نصب
نصب پکیج whl commented-configparser-1.0.0:
pip install commented-configparser-1.0.0.whl
نصب پکیج tar.gz commented-configparser-1.0.0:
pip install commented-configparser-1.0.0.tar.gz