summaryrefslogtreecommitdiff
path: root/python-tryceratops.spec
blob: a945dc380c708521e87d4d9b9f4ec003bb5f6645 (plain)
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
%global _empty_manifest_terminate_build 0
Name:		python-tryceratops
Version:	2.0.0
Release:	1
Summary:	Prevent Exception Handling AntiPatterns
License:	MIT
URL:		https://github.com/guilatrova/tryceratops
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/0f/44/06781b5706ae3c685bc09fd63528151cf58ce36ee23a120153d07bc681ca/tryceratops-2.0.0.tar.gz
BuildArch:	noarch

Requires:	python3-click
Requires:	python3-rich
Requires:	python3-toml

%description
## Installation and usage
### Installation
```
pip install tryceratops
```
OR
```
poetry add -D tryceratops
```
### Usage
```
tryceratops [filename or dir...]
```
You can enable experimental analyzers by running:
```
tryceratops --experimental [filename or dir...]
```
You can ignore specific violations by using: `--ignore TRYXXX` repeatedly:
```
tryceratops --ignore TRY201 --ignore TRY202 [filename or dir...]
```
You can exclude dirs by using: `--exclude dir/path` repeatedly:
```
tryceratops --exclude tests --exclude .venv [filename or dir...]
```
You can also autofix some violations:
```
tryceratops --autofix [filename or dir...]
```
![example](https://raw.githubusercontent.com/guilatrova/tryceratops/main/img/tryceratops-example3.gif)
### [`flake8`](https://github.com/PyCQA/flake8) Plugin
🦖 Tryceratops is also a plugin for `flake8`, so you can:
```
❯ flake8 --select TRY src/tests/samples/violations/call_raise_vanilla.py
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY002 Create your own exception
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY003 Avoid specifying long messages outside the exception class
src/tests/samples/violations/call_raise_vanilla.py:21:9: TRY201 Simply use 'raise' without specifying exception object again
```
## Violations
All violations and its descriptions can be found in [docs](https://github.com/guilatrova/tryceratops/tree/main/docs/violations).
### Autofix support
So far, autofix only supports violations: [TRY200](docs/violations/TRY200.md), [TRY201](docs/violations/TRY201.md), and [TRY400](docs/violations/TRY400.md).
### Ignoring violations
If you want to ignore a violation in a specific file, you can either:
- Add a comment with `noqa` to the top of the file you want to ignore
- Add a comment with `noqa` to the line you want to ignore
- Add a comment with `noqa: CODE` to the line you want to ignore a specific violation
Example:
```py
def verbose_reraise_1():
    try:
        a = 1
    except Exception as ex:
        raise ex  # noqa: TRY202
```
### Configuration
You can set up a `pyproject.toml` file to set rules.
This is useful to avoid reusing the same CLI flags over and over again and helps to define the structure of your project.
Example:
```toml
[tool.tryceratops]
exclude = ["samples"]
ignore = ["TRY002", "TRY200", "TRY300"]
experimental = true
```
CLI flags always overwrite the config file.
## Pre-commit
If you wish to use pre-commit, add this:
```yaml
  - repo: https://github.com/guilatrova/tryceratops
    rev: v2.0.0
    hooks:
      - id: tryceratops
```
## Show your style
[![try/except style: tryceratops](https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black)](https://github.com/guilatrova/tryceratops)
Add this fancy badge to your project's `README.md`:
```md
[![try/except style: tryceratops](https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black)](https://github.com/guilatrova/tryceratops)
```
## Extra Resources
If you want to read more about:
- [How to structure exceptions in Python 🐍 🏗️ 💣](https://blog.guilatrova.dev/how-to-structure-exception-in-python-like-a-pro/)
- [How to log in Python 🐍🌴](https://blog.guilatrova.dev/how-to-log-in-python-like-a-pro/)
- [Book: Effective Python](https://amzn.to/3bEVHpG)
## Contributing
Thank you for considering making Tryceratops better for everyone!
Refer to [Contributing docs](docs/CONTRIBUTING.md).
## Change log
See [CHANGELOG](CHANGELOG.md).
## License
MIT
## Credits
Thanks to God for the inspiration 🙌 ☁️ ☀️
The [black](https://github.com/psf/black) project for insights.

%package -n python3-tryceratops
Summary:	Prevent Exception Handling AntiPatterns
Provides:	python-tryceratops
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-tryceratops
## Installation and usage
### Installation
```
pip install tryceratops
```
OR
```
poetry add -D tryceratops
```
### Usage
```
tryceratops [filename or dir...]
```
You can enable experimental analyzers by running:
```
tryceratops --experimental [filename or dir...]
```
You can ignore specific violations by using: `--ignore TRYXXX` repeatedly:
```
tryceratops --ignore TRY201 --ignore TRY202 [filename or dir...]
```
You can exclude dirs by using: `--exclude dir/path` repeatedly:
```
tryceratops --exclude tests --exclude .venv [filename or dir...]
```
You can also autofix some violations:
```
tryceratops --autofix [filename or dir...]
```
![example](https://raw.githubusercontent.com/guilatrova/tryceratops/main/img/tryceratops-example3.gif)
### [`flake8`](https://github.com/PyCQA/flake8) Plugin
🦖 Tryceratops is also a plugin for `flake8`, so you can:
```
❯ flake8 --select TRY src/tests/samples/violations/call_raise_vanilla.py
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY002 Create your own exception
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY003 Avoid specifying long messages outside the exception class
src/tests/samples/violations/call_raise_vanilla.py:21:9: TRY201 Simply use 'raise' without specifying exception object again
```
## Violations
All violations and its descriptions can be found in [docs](https://github.com/guilatrova/tryceratops/tree/main/docs/violations).
### Autofix support
So far, autofix only supports violations: [TRY200](docs/violations/TRY200.md), [TRY201](docs/violations/TRY201.md), and [TRY400](docs/violations/TRY400.md).
### Ignoring violations
If you want to ignore a violation in a specific file, you can either:
- Add a comment with `noqa` to the top of the file you want to ignore
- Add a comment with `noqa` to the line you want to ignore
- Add a comment with `noqa: CODE` to the line you want to ignore a specific violation
Example:
```py
def verbose_reraise_1():
    try:
        a = 1
    except Exception as ex:
        raise ex  # noqa: TRY202
```
### Configuration
You can set up a `pyproject.toml` file to set rules.
This is useful to avoid reusing the same CLI flags over and over again and helps to define the structure of your project.
Example:
```toml
[tool.tryceratops]
exclude = ["samples"]
ignore = ["TRY002", "TRY200", "TRY300"]
experimental = true
```
CLI flags always overwrite the config file.
## Pre-commit
If you wish to use pre-commit, add this:
```yaml
  - repo: https://github.com/guilatrova/tryceratops
    rev: v2.0.0
    hooks:
      - id: tryceratops
```
## Show your style
[![try/except style: tryceratops](https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black)](https://github.com/guilatrova/tryceratops)
Add this fancy badge to your project's `README.md`:
```md
[![try/except style: tryceratops](https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black)](https://github.com/guilatrova/tryceratops)
```
## Extra Resources
If you want to read more about:
- [How to structure exceptions in Python 🐍 🏗️ 💣](https://blog.guilatrova.dev/how-to-structure-exception-in-python-like-a-pro/)
- [How to log in Python 🐍🌴](https://blog.guilatrova.dev/how-to-log-in-python-like-a-pro/)
- [Book: Effective Python](https://amzn.to/3bEVHpG)
## Contributing
Thank you for considering making Tryceratops better for everyone!
Refer to [Contributing docs](docs/CONTRIBUTING.md).
## Change log
See [CHANGELOG](CHANGELOG.md).
## License
MIT
## Credits
Thanks to God for the inspiration 🙌 ☁️ ☀️
The [black](https://github.com/psf/black) project for insights.

%package help
Summary:	Development documents and examples for tryceratops
Provides:	python3-tryceratops-doc
%description help
## Installation and usage
### Installation
```
pip install tryceratops
```
OR
```
poetry add -D tryceratops
```
### Usage
```
tryceratops [filename or dir...]
```
You can enable experimental analyzers by running:
```
tryceratops --experimental [filename or dir...]
```
You can ignore specific violations by using: `--ignore TRYXXX` repeatedly:
```
tryceratops --ignore TRY201 --ignore TRY202 [filename or dir...]
```
You can exclude dirs by using: `--exclude dir/path` repeatedly:
```
tryceratops --exclude tests --exclude .venv [filename or dir...]
```
You can also autofix some violations:
```
tryceratops --autofix [filename or dir...]
```
![example](https://raw.githubusercontent.com/guilatrova/tryceratops/main/img/tryceratops-example3.gif)
### [`flake8`](https://github.com/PyCQA/flake8) Plugin
🦖 Tryceratops is also a plugin for `flake8`, so you can:
```
❯ flake8 --select TRY src/tests/samples/violations/call_raise_vanilla.py
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY002 Create your own exception
src/tests/samples/violations/call_raise_vanilla.py:13:9: TRY003 Avoid specifying long messages outside the exception class
src/tests/samples/violations/call_raise_vanilla.py:21:9: TRY201 Simply use 'raise' without specifying exception object again
```
## Violations
All violations and its descriptions can be found in [docs](https://github.com/guilatrova/tryceratops/tree/main/docs/violations).
### Autofix support
So far, autofix only supports violations: [TRY200](docs/violations/TRY200.md), [TRY201](docs/violations/TRY201.md), and [TRY400](docs/violations/TRY400.md).
### Ignoring violations
If you want to ignore a violation in a specific file, you can either:
- Add a comment with `noqa` to the top of the file you want to ignore
- Add a comment with `noqa` to the line you want to ignore
- Add a comment with `noqa: CODE` to the line you want to ignore a specific violation
Example:
```py
def verbose_reraise_1():
    try:
        a = 1
    except Exception as ex:
        raise ex  # noqa: TRY202
```
### Configuration
You can set up a `pyproject.toml` file to set rules.
This is useful to avoid reusing the same CLI flags over and over again and helps to define the structure of your project.
Example:
```toml
[tool.tryceratops]
exclude = ["samples"]
ignore = ["TRY002", "TRY200", "TRY300"]
experimental = true
```
CLI flags always overwrite the config file.
## Pre-commit
If you wish to use pre-commit, add this:
```yaml
  - repo: https://github.com/guilatrova/tryceratops
    rev: v2.0.0
    hooks:
      - id: tryceratops
```
## Show your style
[![try/except style: tryceratops](https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black)](https://github.com/guilatrova/tryceratops)
Add this fancy badge to your project's `README.md`:
```md
[![try/except style: tryceratops](https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black)](https://github.com/guilatrova/tryceratops)
```
## Extra Resources
If you want to read more about:
- [How to structure exceptions in Python 🐍 🏗️ 💣](https://blog.guilatrova.dev/how-to-structure-exception-in-python-like-a-pro/)
- [How to log in Python 🐍🌴](https://blog.guilatrova.dev/how-to-log-in-python-like-a-pro/)
- [Book: Effective Python](https://amzn.to/3bEVHpG)
## Contributing
Thank you for considering making Tryceratops better for everyone!
Refer to [Contributing docs](docs/CONTRIBUTING.md).
## Change log
See [CHANGELOG](CHANGELOG.md).
## License
MIT
## Credits
Thanks to God for the inspiration 🙌 ☁️ ☀️
The [black](https://github.com/psf/black) project for insights.

%prep
%autosetup -n tryceratops-2.0.0

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-tryceratops -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 2.0.0-1
- Package Spec generated