gypt_matplotlib 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- gypt_matplotlib-0.1.0/LICENSE +21 -0
- gypt_matplotlib-0.1.0/PKG-INFO +116 -0
- gypt_matplotlib-0.1.0/README.md +84 -0
- gypt_matplotlib-0.1.0/gypt_matplotlib/__init__.py +26 -0
- gypt_matplotlib-0.1.0/gypt_matplotlib/constants.py +17 -0
- gypt_matplotlib-0.1.0/gypt_matplotlib/context_managers.py +97 -0
- gypt_matplotlib-0.1.0/gypt_matplotlib/gypt.mplstyle +1 -0
- gypt_matplotlib-0.1.0/pyproject.toml +171 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 AlbertUnruh/Keenan Noack
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: gypt_matplotlib
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A small addon for matplotlib that can be used for the GYPT.
|
|
5
|
+
License: MIT
|
|
6
|
+
Keywords: Albert Unruh,GYPT,German Young Physicists' Tournament,matplotlib,addon
|
|
7
|
+
Author: Keenan Noack
|
|
8
|
+
Author-email: AlbertUnruh@pm.me
|
|
9
|
+
Requires-Python: >=3.12
|
|
10
|
+
Classifier: Framework :: Matplotlib
|
|
11
|
+
Classifier: Intended Audience :: Education
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Natural Language :: German
|
|
15
|
+
Classifier: Natural Language :: English
|
|
16
|
+
Classifier: Operating System :: OS Independent
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
22
|
+
Classifier: Topic :: Scientific/Engineering :: Visualization
|
|
23
|
+
Classifier: Topic :: Utilities
|
|
24
|
+
Classifier: Typing :: Typed
|
|
25
|
+
Requires-Dist: matplotlib (>=3.10.1,<4.0.0)
|
|
26
|
+
Requires-Dist: pyqt6 (>=6.8.1,<7.0.0)
|
|
27
|
+
Project-URL: Homepage, https://github.com/AlbertUnruh/gypt-matplotlib
|
|
28
|
+
Project-URL: issues, https://github.com/AlbertUnruh/gypt-matplotlib/issues
|
|
29
|
+
Project-URL: soucecode, https://github.com/AlbertUnruh/gypt-matplotlib
|
|
30
|
+
Description-Content-Type: text/markdown
|
|
31
|
+
|
|
32
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/blob/develop/LICENSE)
|
|
33
|
+
[](https://python.org)
|
|
34
|
+
[](https://pypi.org/project/gypt_matplotlib/)
|
|
35
|
+
[](https://github.com/psf/black)
|
|
36
|
+
</br>
|
|
37
|
+
[](https://results.pre-commit.ci/latest/github/AlbertUnruh/gypt-matplotlib/develop)
|
|
38
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/actions/workflows/codeql.yml)
|
|
39
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/actions/workflows/pytest.yml)
|
|
40
|
+
</br>
|
|
41
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/issues)
|
|
42
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/pulls)
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
# gypt-matplotlib
|
|
46
|
+
A small addon for matplotlib that can be used for the GYPT.
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### GYPT?
|
|
52
|
+
GYPT stands for **G**erman **Y**oung **P**hysicists’ **T**ournament.
|
|
53
|
+
|
|
54
|
+
Further information can be found at [gypt.org][].
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### Where did you get the stylesheet?
|
|
58
|
+
It's available over [here][stylesheet] at the [GYPT wiki][wiki].
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
[gypt.org]: https://gypt.org
|
|
62
|
+
[wiki]: https://wiki.gypt.org
|
|
63
|
+
[stylesheet]: https://wiki.gypt.org/index.php/Python/stylesheet
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
### How to use:
|
|
69
|
+
|
|
70
|
+
#### Applying GYPT-stylesheet
|
|
71
|
+
Just import the library. The stylesheet will be automatically applied.
|
|
72
|
+
```python
|
|
73
|
+
import gypt_matplotlib as gypt
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
#### Creating plots with ``a.u.`` (arbitrary units)
|
|
77
|
+
You can use the context manager ``gypt.au_plot()``
|
|
78
|
+
to create plots where the concept and not the actual numbers are important.
|
|
79
|
+
```python
|
|
80
|
+
import matplotlib.pyplot as plt
|
|
81
|
+
import gypt_matplotlib as gypt
|
|
82
|
+
|
|
83
|
+
with gypt.au_plot():
|
|
84
|
+
plt.title("Demo of plot without numbers on X-/Y-Axis.")
|
|
85
|
+
plt.show()
|
|
86
|
+
|
|
87
|
+
# or even more advanced:
|
|
88
|
+
with gypt.au_plot(), gypt.auto_save_and_show("path/to/file.png"):
|
|
89
|
+
plt.title("Demo of plot without numbers on X-/Y-Axis.")
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
#### Using other diverse context managers
|
|
93
|
+
```python
|
|
94
|
+
import matplotlib.pyplot as plt
|
|
95
|
+
import gypt_matplotlib as gypt
|
|
96
|
+
|
|
97
|
+
with gypt.auto_close():
|
|
98
|
+
# This context manager automatically calls ``plt.close()``.
|
|
99
|
+
# Saving and displaying have to be done manually!
|
|
100
|
+
...
|
|
101
|
+
|
|
102
|
+
with gypt.auto_show():
|
|
103
|
+
# This context manager automatically calls ``plt.show()`` and ``plt.close()``.
|
|
104
|
+
# It's incompatible with ``gypt.auto_save()``! Use ``gypt.auto_save_and_show()`` instead!
|
|
105
|
+
...
|
|
106
|
+
|
|
107
|
+
with gypt.auto_save("path/to/file.png"):
|
|
108
|
+
# This context manager automatically calls ``plt.savefig()`` and ``plt.close()``.
|
|
109
|
+
# It's incompatible with ``gypt.auto_show()``! Use ``gypt.auto_save_and_show()`` instead!
|
|
110
|
+
...
|
|
111
|
+
|
|
112
|
+
with gypt.auto_save_and_show("path/to/file.png"):
|
|
113
|
+
# This context manager automatically calls ``plt.savefig()``, ``plt.show()`` and ``plt.close()``.
|
|
114
|
+
...
|
|
115
|
+
```
|
|
116
|
+
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/blob/develop/LICENSE)
|
|
2
|
+
[](https://python.org)
|
|
3
|
+
[](https://pypi.org/project/gypt_matplotlib/)
|
|
4
|
+
[](https://github.com/psf/black)
|
|
5
|
+
</br>
|
|
6
|
+
[](https://results.pre-commit.ci/latest/github/AlbertUnruh/gypt-matplotlib/develop)
|
|
7
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/actions/workflows/codeql.yml)
|
|
8
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/actions/workflows/pytest.yml)
|
|
9
|
+
</br>
|
|
10
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/issues)
|
|
11
|
+
[](https://github.com/AlbertUnruh/gypt-matplotlib/pulls)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# gypt-matplotlib
|
|
15
|
+
A small addon for matplotlib that can be used for the GYPT.
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
### GYPT?
|
|
21
|
+
GYPT stands for **G**erman **Y**oung **P**hysicists’ **T**ournament.
|
|
22
|
+
|
|
23
|
+
Further information can be found at [gypt.org][].
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Where did you get the stylesheet?
|
|
27
|
+
It's available over [here][stylesheet] at the [GYPT wiki][wiki].
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
[gypt.org]: https://gypt.org
|
|
31
|
+
[wiki]: https://wiki.gypt.org
|
|
32
|
+
[stylesheet]: https://wiki.gypt.org/index.php/Python/stylesheet
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
### How to use:
|
|
38
|
+
|
|
39
|
+
#### Applying GYPT-stylesheet
|
|
40
|
+
Just import the library. The stylesheet will be automatically applied.
|
|
41
|
+
```python
|
|
42
|
+
import gypt_matplotlib as gypt
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
#### Creating plots with ``a.u.`` (arbitrary units)
|
|
46
|
+
You can use the context manager ``gypt.au_plot()``
|
|
47
|
+
to create plots where the concept and not the actual numbers are important.
|
|
48
|
+
```python
|
|
49
|
+
import matplotlib.pyplot as plt
|
|
50
|
+
import gypt_matplotlib as gypt
|
|
51
|
+
|
|
52
|
+
with gypt.au_plot():
|
|
53
|
+
plt.title("Demo of plot without numbers on X-/Y-Axis.")
|
|
54
|
+
plt.show()
|
|
55
|
+
|
|
56
|
+
# or even more advanced:
|
|
57
|
+
with gypt.au_plot(), gypt.auto_save_and_show("path/to/file.png"):
|
|
58
|
+
plt.title("Demo of plot without numbers on X-/Y-Axis.")
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
#### Using other diverse context managers
|
|
62
|
+
```python
|
|
63
|
+
import matplotlib.pyplot as plt
|
|
64
|
+
import gypt_matplotlib as gypt
|
|
65
|
+
|
|
66
|
+
with gypt.auto_close():
|
|
67
|
+
# This context manager automatically calls ``plt.close()``.
|
|
68
|
+
# Saving and displaying have to be done manually!
|
|
69
|
+
...
|
|
70
|
+
|
|
71
|
+
with gypt.auto_show():
|
|
72
|
+
# This context manager automatically calls ``plt.show()`` and ``plt.close()``.
|
|
73
|
+
# It's incompatible with ``gypt.auto_save()``! Use ``gypt.auto_save_and_show()`` instead!
|
|
74
|
+
...
|
|
75
|
+
|
|
76
|
+
with gypt.auto_save("path/to/file.png"):
|
|
77
|
+
# This context manager automatically calls ``plt.savefig()`` and ``plt.close()``.
|
|
78
|
+
# It's incompatible with ``gypt.auto_show()``! Use ``gypt.auto_save_and_show()`` instead!
|
|
79
|
+
...
|
|
80
|
+
|
|
81
|
+
with gypt.auto_save_and_show("path/to/file.png"):
|
|
82
|
+
# This context manager automatically calls ``plt.savefig()``, ``plt.show()`` and ``plt.close()``.
|
|
83
|
+
...
|
|
84
|
+
```
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
__version__ = "0.1.0"
|
|
2
|
+
__description__ = "A small addon for matplotlib that can be used for the GYPT."
|
|
3
|
+
__license__ = "MIT"
|
|
4
|
+
__authors__ = ["Keenan Noack <AlbertUnruh@pm.me>"]
|
|
5
|
+
__repository__ = "https://github.com/AlbertUnruh/gypt-matplotlib/"
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
# third party
|
|
9
|
+
import matplotlib.pyplot as plt
|
|
10
|
+
|
|
11
|
+
# local
|
|
12
|
+
from .constants import PKG_PATH
|
|
13
|
+
from .context_managers import au_plot, auto_close, auto_save, auto_save_and_show, auto_show
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
__all__ = (
|
|
17
|
+
"au_plot",
|
|
18
|
+
"auto_close",
|
|
19
|
+
"auto_save",
|
|
20
|
+
"auto_save_and_show",
|
|
21
|
+
"auto_show",
|
|
22
|
+
)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
# automatically apply the GYPT style
|
|
26
|
+
plt.style.use(PKG_PATH / "gypt.mplstyle")
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# standard library
|
|
2
|
+
from pathlib import Path
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
__all__ = ("AU_STYLE", "PKG_PATH")
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
PKG_PATH: Path = Path(__file__).parent # package path
|
|
9
|
+
|
|
10
|
+
AU_STYLE: dict[str, bool] = { # Style for plots with a.u. (arbitrary units)
|
|
11
|
+
"xtick.top": False,
|
|
12
|
+
"xtick.bottom": False,
|
|
13
|
+
"xtick.labelbottom": False,
|
|
14
|
+
"ytick.left": False,
|
|
15
|
+
"ytick.right": False,
|
|
16
|
+
"ytick.labelleft": False,
|
|
17
|
+
}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# standard library
|
|
2
|
+
from contextlib import contextmanager
|
|
3
|
+
from pathlib import Path
|
|
4
|
+
|
|
5
|
+
# third party
|
|
6
|
+
import matplotlib.pyplot as plt
|
|
7
|
+
|
|
8
|
+
# local
|
|
9
|
+
from .constants import AU_STYLE
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
__all__ = (
|
|
13
|
+
"au_plot",
|
|
14
|
+
"auto_close",
|
|
15
|
+
"auto_save",
|
|
16
|
+
"auto_save_and_show",
|
|
17
|
+
"auto_show",
|
|
18
|
+
)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
@contextmanager
|
|
22
|
+
def au_plot():
|
|
23
|
+
"""Contextmanager for plots with a.u. (arbitrary units)."""
|
|
24
|
+
with plt.style.context(AU_STYLE):
|
|
25
|
+
yield
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
@contextmanager
|
|
29
|
+
def auto_close():
|
|
30
|
+
"""Contextmanager to automatically close plots."""
|
|
31
|
+
yield
|
|
32
|
+
plt.close()
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
@contextmanager
|
|
36
|
+
def auto_save(fname: Path | str, **kwargs: ...):
|
|
37
|
+
"""
|
|
38
|
+
Contextmanager to automatically save and close plots.
|
|
39
|
+
|
|
40
|
+
Parameters
|
|
41
|
+
----------
|
|
42
|
+
fname : Path or str
|
|
43
|
+
The filename or path to save the plot to.
|
|
44
|
+
|
|
45
|
+
Other Parameters
|
|
46
|
+
----------------
|
|
47
|
+
**kwargs
|
|
48
|
+
Will be passed to `plt.savefig()`.
|
|
49
|
+
|
|
50
|
+
Warnings
|
|
51
|
+
--------
|
|
52
|
+
This is incompatible with `auto_show`! Use `auto_save_and_show` instead!
|
|
53
|
+
|
|
54
|
+
See Also
|
|
55
|
+
--------
|
|
56
|
+
plt.savefig()
|
|
57
|
+
"""
|
|
58
|
+
with auto_close():
|
|
59
|
+
yield
|
|
60
|
+
plt.savefig(fname, **kwargs)
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
@contextmanager
|
|
64
|
+
def auto_show():
|
|
65
|
+
"""
|
|
66
|
+
Contextmanager to automatically show and close plots.
|
|
67
|
+
|
|
68
|
+
Warnings
|
|
69
|
+
--------
|
|
70
|
+
This is incompatible with `auto_save`! Use `auto_save_and_show` instead!
|
|
71
|
+
"""
|
|
72
|
+
with auto_close(): # pragma: no cover # plt.show() won't be tested
|
|
73
|
+
yield
|
|
74
|
+
plt.show()
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
@contextmanager
|
|
78
|
+
def auto_save_and_show(fname: Path | str, **kwargs: ...):
|
|
79
|
+
"""
|
|
80
|
+
Contextmanager to automatically save, show and close plots.
|
|
81
|
+
|
|
82
|
+
It combines the basic functionality of ``auto_save`` and ``auto_show``.
|
|
83
|
+
|
|
84
|
+
Parameters
|
|
85
|
+
----------
|
|
86
|
+
fname : Path or str
|
|
87
|
+
The filename or path to save the plot to.
|
|
88
|
+
|
|
89
|
+
Other Parameters
|
|
90
|
+
----------------
|
|
91
|
+
**kwargs
|
|
92
|
+
Will be passed to `plt.savefig()`.
|
|
93
|
+
"""
|
|
94
|
+
with auto_close(): # pragma: no cover # plt.show() won't be tested
|
|
95
|
+
yield
|
|
96
|
+
plt.savefig(fname, **kwargs)
|
|
97
|
+
plt.show()
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# COMING SOON
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "gypt_matplotlib"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "A small addon for matplotlib that can be used for the GYPT."
|
|
5
|
+
authors = [
|
|
6
|
+
{name = "Keenan Noack", email = "AlbertUnruh@pm.me"}
|
|
7
|
+
]
|
|
8
|
+
readme = "README.md"
|
|
9
|
+
license = "MIT"
|
|
10
|
+
license-files = ["LICENSE"]
|
|
11
|
+
keywords = ["Albert Unruh", "GYPT", "German Young Physicists' Tournament", "matplotlib", "addon"]
|
|
12
|
+
classifiers = [
|
|
13
|
+
"Framework :: Matplotlib",
|
|
14
|
+
"Intended Audience :: Education",
|
|
15
|
+
"Intended Audience :: Science/Research",
|
|
16
|
+
"License :: OSI Approved :: MIT License",
|
|
17
|
+
"Natural Language :: German", # it's a German tournament ...
|
|
18
|
+
"Natural Language :: English", # ... held in English
|
|
19
|
+
"Operating System :: OS Independent",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Programming Language :: Python :: 3.13",
|
|
24
|
+
"Topic :: Scientific/Engineering :: Physics",
|
|
25
|
+
"Topic :: Scientific/Engineering :: Visualization",
|
|
26
|
+
"Topic :: Utilities",
|
|
27
|
+
"Typing :: Typed",
|
|
28
|
+
]
|
|
29
|
+
|
|
30
|
+
dynamic = ["dependencies", "optional-dependencies"]
|
|
31
|
+
requires-python = ">=3.12"
|
|
32
|
+
|
|
33
|
+
[project.urls]
|
|
34
|
+
homepage = "https://github.com/AlbertUnruh/gypt-matplotlib"
|
|
35
|
+
soucecode = "https://github.com/AlbertUnruh/gypt-matplotlib"
|
|
36
|
+
issues = "https://github.com/AlbertUnruh/gypt-matplotlib/issues"
|
|
37
|
+
|
|
38
|
+
[build-system]
|
|
39
|
+
requires = ["poetry-core>=2.0.0,<3.0.0"]
|
|
40
|
+
build-backend = "poetry.core.masonry.api"
|
|
41
|
+
|
|
42
|
+
[tool.poetry]
|
|
43
|
+
requires-poetry = ">=2.0"
|
|
44
|
+
include = ["gypt_matplotlib/gypt.mplstyle"]
|
|
45
|
+
|
|
46
|
+
[tool.poetry.dependencies]
|
|
47
|
+
matplotlib = "^3.10.1"
|
|
48
|
+
pyqt6 = "^6.8.1"
|
|
49
|
+
|
|
50
|
+
[tool.poetry.group.dev.dependencies]
|
|
51
|
+
black = ">=25.1.0" # major and minor aren't semantically versioned but on year and month
|
|
52
|
+
pre-commit = "^4.2.0"
|
|
53
|
+
|
|
54
|
+
[tool.poetry.group.tests.dependencies]
|
|
55
|
+
pytest = "^8.3.5"
|
|
56
|
+
pytest-cov = "^6.0.0"
|
|
57
|
+
pillow = "^11.1.0"
|
|
58
|
+
|
|
59
|
+
[tool.black]
|
|
60
|
+
line-length = 120
|
|
61
|
+
target-version = ["py312"]
|
|
62
|
+
include = "\\.pyi?$"
|
|
63
|
+
|
|
64
|
+
[tool.pytest.ini_options]
|
|
65
|
+
addopts = "--cov=gypt_matplotlib --cov-report html"
|
|
66
|
+
|
|
67
|
+
[tool.coverage.report]
|
|
68
|
+
omit = [
|
|
69
|
+
"gypt_matplotlib/__init__.py",
|
|
70
|
+
"gypt_matplotlib/__main__.py",
|
|
71
|
+
]
|
|
72
|
+
exclude_also = [
|
|
73
|
+
"def __repr__",
|
|
74
|
+
"raise NotImplementedError",
|
|
75
|
+
"if __name__ == .__main__.:",
|
|
76
|
+
"if TYPE_CHECKING:",
|
|
77
|
+
"class .*\\bProtocol\\):",
|
|
78
|
+
"@(abc\\.)?abstractmethod",
|
|
79
|
+
]
|
|
80
|
+
|
|
81
|
+
[tool.isort]
|
|
82
|
+
line_length = 120
|
|
83
|
+
py_version = 312
|
|
84
|
+
profile = "black"
|
|
85
|
+
lines_after_imports = 2
|
|
86
|
+
lines_between_sections = 1
|
|
87
|
+
split_on_trailing_comma = true
|
|
88
|
+
sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "LOCALFOLDER"]
|
|
89
|
+
import_heading_stdlib = "standard library"
|
|
90
|
+
import_heading_thirdparty = "third party"
|
|
91
|
+
import_heading_firstparty = "first party"
|
|
92
|
+
import_heading_localfolder = "local"
|
|
93
|
+
|
|
94
|
+
[tool.ruff]
|
|
95
|
+
line-length = 120
|
|
96
|
+
target-version = "py312"
|
|
97
|
+
output-format = "concise" # set to full if you want to see the source of the error/warning
|
|
98
|
+
|
|
99
|
+
[tool.ruff.lint]
|
|
100
|
+
task-tags = ["TODO", "FIXME", "NOTE"]
|
|
101
|
+
select = [
|
|
102
|
+
"F", # Pyflakes
|
|
103
|
+
"E", # pycodestyle
|
|
104
|
+
"W", # pycodestyle
|
|
105
|
+
"C90", # mccabe
|
|
106
|
+
"N", # pep8-naming
|
|
107
|
+
"D", # pydocstyle
|
|
108
|
+
"UP", # pyudpgrade
|
|
109
|
+
"YTT", # flake8-2020
|
|
110
|
+
"ANN", # flake8-annotations
|
|
111
|
+
"S", # flake8-bandit
|
|
112
|
+
"BLE", # flake8-blind-except
|
|
113
|
+
"FBT", # flake8-boolean-trap
|
|
114
|
+
"B", # flake8-bugbear
|
|
115
|
+
"A", # flake8-builtins
|
|
116
|
+
"C4", # flake8-comprehensions
|
|
117
|
+
"DTZ", # flake8-datetimez
|
|
118
|
+
"T10", # flake8-debugger
|
|
119
|
+
"EM", # flake8-errmsg
|
|
120
|
+
"ISC", # flake8-implicit-str-concat
|
|
121
|
+
"ICN", # flake8-import-conventions
|
|
122
|
+
"LOG", # flake8-logging
|
|
123
|
+
"G", # flake8-logging-format
|
|
124
|
+
"INP", # flake8-no-pep420
|
|
125
|
+
"PIE", # flake8-pie
|
|
126
|
+
"T20", # flake8-print
|
|
127
|
+
"PT", # flake8-pytest-style
|
|
128
|
+
"Q", # flake8-quotes
|
|
129
|
+
"RSE", # flake8-raise
|
|
130
|
+
"RET", # flake8-return
|
|
131
|
+
"SLF", # flake8-self
|
|
132
|
+
"SIM", # flake8-simplify
|
|
133
|
+
"TCH", # flake8-type-checking
|
|
134
|
+
"TC", # flake8-type-checking
|
|
135
|
+
"INT", # flake8-gettext
|
|
136
|
+
"ARG", # flake8-unused-arguments
|
|
137
|
+
"PTH", # flake8-use-pathlib
|
|
138
|
+
"PLC", # Pylint Convention
|
|
139
|
+
"PLE", # Pylint Error
|
|
140
|
+
"PLR", # Pylint Refactor
|
|
141
|
+
"PLW", # Pylint Warning
|
|
142
|
+
"TRY", # tryceratops
|
|
143
|
+
"FLY", # flynt
|
|
144
|
+
"PERF", # Perflint
|
|
145
|
+
"FURB", # refurb
|
|
146
|
+
"RUF", # Ruff-specific rules
|
|
147
|
+
]
|
|
148
|
+
ignore = [
|
|
149
|
+
"D100", # Missing docstring in public module
|
|
150
|
+
"D104", # Missing docstring in public package
|
|
151
|
+
"G002", # Logging statement uses `%`
|
|
152
|
+
"G004", # Logging statement uses f-string
|
|
153
|
+
]
|
|
154
|
+
per-file-ignores = {"tests/*.py" = ["D103", "S101", "FBT001"]}
|
|
155
|
+
|
|
156
|
+
[tool.ruff.lint.flake8-annotations]
|
|
157
|
+
mypy-init-return = true
|
|
158
|
+
suppress-dummy-args = true
|
|
159
|
+
suppress-none-returning = true
|
|
160
|
+
|
|
161
|
+
[tool.ruff.lint.flake8-errmsg]
|
|
162
|
+
max-string-length = 20
|
|
163
|
+
|
|
164
|
+
[tool.ruff.lint.flake8-quotes]
|
|
165
|
+
docstring-quotes = "double"
|
|
166
|
+
|
|
167
|
+
[tool.ruff.lint.mccabe]
|
|
168
|
+
max-complexity = 13
|
|
169
|
+
|
|
170
|
+
[tool.ruff.lint.pydocstyle]
|
|
171
|
+
convention = "numpy"
|