pysayme 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.
- pysayme-0.1.0/.github/dependabot.yml +10 -0
- pysayme-0.1.0/.github/workflows/ci.yml +53 -0
- pysayme-0.1.0/.github/workflows/release.yml +38 -0
- pysayme-0.1.0/.gitignore +9 -0
- pysayme-0.1.0/LICENSE +201 -0
- pysayme-0.1.0/PKG-INFO +113 -0
- pysayme-0.1.0/README.md +84 -0
- pysayme-0.1.0/docs/design.md +98 -0
- pysayme-0.1.0/docs/releasing.md +39 -0
- pysayme-0.1.0/docs/validation.md +88 -0
- pysayme-0.1.0/pyproject.toml +79 -0
- pysayme-0.1.0/src/pysayme/__init__.py +26 -0
- pysayme-0.1.0/src/pysayme/cli.py +75 -0
- pysayme-0.1.0/src/pysayme/config.py +141 -0
- pysayme-0.1.0/src/pysayme/extract.py +269 -0
- pysayme-0.1.0/src/pysayme/gate.py +86 -0
- pysayme-0.1.0/src/pysayme/match.py +204 -0
- pysayme-0.1.0/src/pysayme/plugin.py +82 -0
- pysayme-0.1.0/src/pysayme/semantic.py +230 -0
- pysayme-0.1.0/src/pysayme/sources.py +274 -0
- pysayme-0.1.0/tests/conftest.py +185 -0
- pysayme-0.1.0/tests/test_config.py +129 -0
- pysayme-0.1.0/tests/test_extract.py +213 -0
- pysayme-0.1.0/tests/test_gate_cli.py +87 -0
- pysayme-0.1.0/tests/test_match.py +187 -0
- pysayme-0.1.0/tests/test_plugin.py +81 -0
- pysayme-0.1.0/tests/test_semantic.py +108 -0
- pysayme-0.1.0/tests/test_sources.py +177 -0
- pysayme-0.1.0/uv.lock +618 -0
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
|
|
11
|
+
env:
|
|
12
|
+
OMP_NUM_THREADS: 2
|
|
13
|
+
MKL_NUM_THREADS: 2
|
|
14
|
+
OPENBLAS_NUM_THREADS: 2
|
|
15
|
+
|
|
16
|
+
jobs:
|
|
17
|
+
lint:
|
|
18
|
+
runs-on: ubuntu-latest
|
|
19
|
+
steps:
|
|
20
|
+
- uses: actions/checkout@v7
|
|
21
|
+
- uses: astral-sh/setup-uv@v10.4.0
|
|
22
|
+
with:
|
|
23
|
+
python-version: "3.13"
|
|
24
|
+
- run: uv sync --group dev
|
|
25
|
+
- run: uv run black --check src tests
|
|
26
|
+
- run: uv run pylint src tests
|
|
27
|
+
|
|
28
|
+
test:
|
|
29
|
+
runs-on: ubuntu-latest
|
|
30
|
+
strategy:
|
|
31
|
+
fail-fast: false
|
|
32
|
+
matrix:
|
|
33
|
+
python: ["3.12", "3.13", "3.14"]
|
|
34
|
+
steps:
|
|
35
|
+
- uses: actions/checkout@v7
|
|
36
|
+
with:
|
|
37
|
+
fetch-depth: 0
|
|
38
|
+
- uses: astral-sh/setup-uv@v10.4.0
|
|
39
|
+
with:
|
|
40
|
+
python-version: ${{ matrix.python }}
|
|
41
|
+
- run: uv sync --group dev
|
|
42
|
+
- run: uv run pytest
|
|
43
|
+
|
|
44
|
+
build:
|
|
45
|
+
runs-on: ubuntu-latest
|
|
46
|
+
steps:
|
|
47
|
+
- uses: actions/checkout@v7
|
|
48
|
+
with:
|
|
49
|
+
fetch-depth: 0
|
|
50
|
+
- uses: astral-sh/setup-uv@v10.4.0
|
|
51
|
+
- run: uv build
|
|
52
|
+
- run: uvx twine check --strict dist/*
|
|
53
|
+
- run: uvx --from dist/*.whl pysayme --version
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: read
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
build:
|
|
12
|
+
runs-on: ubuntu-latest
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v7
|
|
15
|
+
with:
|
|
16
|
+
fetch-depth: 0
|
|
17
|
+
- uses: astral-sh/setup-uv@v10.4.0
|
|
18
|
+
- run: uv build
|
|
19
|
+
- run: uvx twine check --strict dist/*
|
|
20
|
+
- uses: actions/upload-artifact@v7
|
|
21
|
+
with:
|
|
22
|
+
name: dist
|
|
23
|
+
path: dist/
|
|
24
|
+
|
|
25
|
+
publish:
|
|
26
|
+
needs: build
|
|
27
|
+
runs-on: ubuntu-latest
|
|
28
|
+
environment:
|
|
29
|
+
name: pypi
|
|
30
|
+
url: https://pypi.org/p/pysayme
|
|
31
|
+
permissions:
|
|
32
|
+
id-token: write
|
|
33
|
+
steps:
|
|
34
|
+
- uses: actions/download-artifact@v8
|
|
35
|
+
with:
|
|
36
|
+
name: dist
|
|
37
|
+
path: dist/
|
|
38
|
+
- uses: pypa/gh-action-pypi-publish@v1.14.3
|
pysayme-0.1.0/.gitignore
ADDED
pysayme-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
pysayme-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: pysayme
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Find project code that duplicates functions or constants its dependencies already export
|
|
5
|
+
Project-URL: Homepage, https://github.com/anarkiwi/pysayme
|
|
6
|
+
Project-URL: Issues, https://github.com/anarkiwi/pysayme/issues
|
|
7
|
+
Author: Josh Bailey
|
|
8
|
+
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Keywords: ast,clone-detection,duplication,lint,pytest
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Framework :: Pytest
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
20
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
21
|
+
Classifier: Topic :: Software Development :: Testing
|
|
22
|
+
Requires-Python: >=3.12
|
|
23
|
+
Requires-Dist: numpy>=1.26
|
|
24
|
+
Requires-Dist: packaging>=23
|
|
25
|
+
Requires-Dist: pytest>=7.4
|
|
26
|
+
Requires-Dist: scipy>=1.11
|
|
27
|
+
Requires-Dist: tqdm>=4.66
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
|
|
30
|
+
# pysayme
|
|
31
|
+
|
|
32
|
+
Finds project code that duplicates functions or constants that the project's own
|
|
33
|
+
installed dependencies already export, and fails a pytest test naming the library
|
|
34
|
+
function to call instead.
|
|
35
|
+
|
|
36
|
+
Clone detectors such as pylint R0801, jscpd and PMD CPD compare a project with itself,
|
|
37
|
+
and they compare text. pysayme compares a project with its dependencies, and it
|
|
38
|
+
compares normalized AST structure, so renamed copies still match.
|
|
39
|
+
|
|
40
|
+
## Install
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
pip install pysayme
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Use
|
|
47
|
+
|
|
48
|
+
### As a pytest gate
|
|
49
|
+
|
|
50
|
+
Add a `[tool.pysayme]` table to `pyproject.toml`:
|
|
51
|
+
|
|
52
|
+
```toml
|
|
53
|
+
[tool.pysayme]
|
|
54
|
+
roots = ["src", "tests"]
|
|
55
|
+
|
|
56
|
+
[tool.pysayme.allow]
|
|
57
|
+
"src/app/util.py:runs -> somelib.masks:runs" = "why this copy is deliberate"
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
A full `pytest` run (no path arguments) then includes one `pyproject.toml::pysayme`
|
|
61
|
+
item. The item fails if any of these hold:
|
|
62
|
+
|
|
63
|
+
- project code duplicates a public dependency function or constant;
|
|
64
|
+
- an allowlist entry no longer matches (so the list only shrinks);
|
|
65
|
+
- an allowlist entry has no reason.
|
|
66
|
+
|
|
67
|
+
| Flag | Effect |
|
|
68
|
+
|---|---|
|
|
69
|
+
| `--pysayme` | run the gate even when paths or tests are selected |
|
|
70
|
+
| `--no-pysayme` | never run it |
|
|
71
|
+
| `-m "not pysayme"` | deselect it |
|
|
72
|
+
|
|
73
|
+
### From the command line
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
pysayme # check, using pyproject.toml
|
|
77
|
+
pysayme --dist numpy scipy -- src tests # explicit dependencies and roots
|
|
78
|
+
pysayme check --all # include allowlisted matches
|
|
79
|
+
pysayme rank --top 3 # rank shape-independent look-alikes
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
`check` exits 1 when there are new duplicates or allowlist problems.
|
|
83
|
+
|
|
84
|
+
## Configuration
|
|
85
|
+
|
|
86
|
+
| Key | Default | Meaning |
|
|
87
|
+
|---|---|---|
|
|
88
|
+
| `roots` | `["."]` | project paths to check; git-tracked and unignored `.py` files |
|
|
89
|
+
| `dists` | discovered | installed distributions to check against |
|
|
90
|
+
| `requirements` | | requirements file(s) to take `dists` from |
|
|
91
|
+
| `extra-dists`, `ignore-dists` | `[]` | add to / remove from the discovered `dists` |
|
|
92
|
+
| `exclude` | `[]` | `fnmatch` globs of project paths to skip |
|
|
93
|
+
| `allow` | `{}` | `"path:qualname -> module:qualname"` keys mapped to reasons |
|
|
94
|
+
| `copy` | `0.45` | shingle Jaccard for a copy |
|
|
95
|
+
| `inlined` | `0.70` | share of a library function found inside a project one |
|
|
96
|
+
| `min-shingles`, `min-inlined` | `12`, `30` | smallest function compared, and smallest one inlined |
|
|
97
|
+
| `private` | `false` | also match private library code |
|
|
98
|
+
| `ambiguous` | `false` | also report matches that fit several library functions |
|
|
99
|
+
| `jobs` | all CPUs | indexing processes |
|
|
100
|
+
| `cache` | `true` | cache dependency indexes (`$PYSAYME_CACHE`, else `~/.cache/pysayme`) |
|
|
101
|
+
|
|
102
|
+
When `dists` and `requirements` are both unset, pysayme uses the installed
|
|
103
|
+
`[project]` dependencies and extras, falling back to `requirements.txt`.
|
|
104
|
+
|
|
105
|
+
## Docs
|
|
106
|
+
|
|
107
|
+
- [docs/design.md](docs/design.md): how matching works
|
|
108
|
+
- [docs/validation.md](docs/validation.md): results on real projects
|
|
109
|
+
- [docs/releasing.md](docs/releasing.md): CI and PyPI publishing
|
|
110
|
+
|
|
111
|
+
## License
|
|
112
|
+
|
|
113
|
+
Apache-2.0
|
pysayme-0.1.0/README.md
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# pysayme
|
|
2
|
+
|
|
3
|
+
Finds project code that duplicates functions or constants that the project's own
|
|
4
|
+
installed dependencies already export, and fails a pytest test naming the library
|
|
5
|
+
function to call instead.
|
|
6
|
+
|
|
7
|
+
Clone detectors such as pylint R0801, jscpd and PMD CPD compare a project with itself,
|
|
8
|
+
and they compare text. pysayme compares a project with its dependencies, and it
|
|
9
|
+
compares normalized AST structure, so renamed copies still match.
|
|
10
|
+
|
|
11
|
+
## Install
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
pip install pysayme
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Use
|
|
18
|
+
|
|
19
|
+
### As a pytest gate
|
|
20
|
+
|
|
21
|
+
Add a `[tool.pysayme]` table to `pyproject.toml`:
|
|
22
|
+
|
|
23
|
+
```toml
|
|
24
|
+
[tool.pysayme]
|
|
25
|
+
roots = ["src", "tests"]
|
|
26
|
+
|
|
27
|
+
[tool.pysayme.allow]
|
|
28
|
+
"src/app/util.py:runs -> somelib.masks:runs" = "why this copy is deliberate"
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
A full `pytest` run (no path arguments) then includes one `pyproject.toml::pysayme`
|
|
32
|
+
item. The item fails if any of these hold:
|
|
33
|
+
|
|
34
|
+
- project code duplicates a public dependency function or constant;
|
|
35
|
+
- an allowlist entry no longer matches (so the list only shrinks);
|
|
36
|
+
- an allowlist entry has no reason.
|
|
37
|
+
|
|
38
|
+
| Flag | Effect |
|
|
39
|
+
|---|---|
|
|
40
|
+
| `--pysayme` | run the gate even when paths or tests are selected |
|
|
41
|
+
| `--no-pysayme` | never run it |
|
|
42
|
+
| `-m "not pysayme"` | deselect it |
|
|
43
|
+
|
|
44
|
+
### From the command line
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
pysayme # check, using pyproject.toml
|
|
48
|
+
pysayme --dist numpy scipy -- src tests # explicit dependencies and roots
|
|
49
|
+
pysayme check --all # include allowlisted matches
|
|
50
|
+
pysayme rank --top 3 # rank shape-independent look-alikes
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
`check` exits 1 when there are new duplicates or allowlist problems.
|
|
54
|
+
|
|
55
|
+
## Configuration
|
|
56
|
+
|
|
57
|
+
| Key | Default | Meaning |
|
|
58
|
+
|---|---|---|
|
|
59
|
+
| `roots` | `["."]` | project paths to check; git-tracked and unignored `.py` files |
|
|
60
|
+
| `dists` | discovered | installed distributions to check against |
|
|
61
|
+
| `requirements` | | requirements file(s) to take `dists` from |
|
|
62
|
+
| `extra-dists`, `ignore-dists` | `[]` | add to / remove from the discovered `dists` |
|
|
63
|
+
| `exclude` | `[]` | `fnmatch` globs of project paths to skip |
|
|
64
|
+
| `allow` | `{}` | `"path:qualname -> module:qualname"` keys mapped to reasons |
|
|
65
|
+
| `copy` | `0.45` | shingle Jaccard for a copy |
|
|
66
|
+
| `inlined` | `0.70` | share of a library function found inside a project one |
|
|
67
|
+
| `min-shingles`, `min-inlined` | `12`, `30` | smallest function compared, and smallest one inlined |
|
|
68
|
+
| `private` | `false` | also match private library code |
|
|
69
|
+
| `ambiguous` | `false` | also report matches that fit several library functions |
|
|
70
|
+
| `jobs` | all CPUs | indexing processes |
|
|
71
|
+
| `cache` | `true` | cache dependency indexes (`$PYSAYME_CACHE`, else `~/.cache/pysayme`) |
|
|
72
|
+
|
|
73
|
+
When `dists` and `requirements` are both unset, pysayme uses the installed
|
|
74
|
+
`[project]` dependencies and extras, falling back to `requirements.txt`.
|
|
75
|
+
|
|
76
|
+
## Docs
|
|
77
|
+
|
|
78
|
+
- [docs/design.md](docs/design.md): how matching works
|
|
79
|
+
- [docs/validation.md](docs/validation.md): results on real projects
|
|
80
|
+
- [docs/releasing.md](docs/releasing.md): CI and PyPI publishing
|
|
81
|
+
|
|
82
|
+
## License
|
|
83
|
+
|
|
84
|
+
Apache-2.0
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
# Design
|
|
2
|
+
|
|
3
|
+
pysayme's own detection is AST-based throughout: `ast`, normalized token hashing, and
|
|
4
|
+
set and cosine similarity. It uses no regular expressions.
|
|
5
|
+
|
|
6
|
+
## Index
|
|
7
|
+
|
|
8
|
+
Indexing covers every `.py` file of each named installed distribution, except test
|
|
9
|
+
directories and `__main__.py`. Distributions installed without a file list (editable
|
|
10
|
+
installs) are found through their top-level import packages.
|
|
11
|
+
|
|
12
|
+
Each function body is normalized as follows:
|
|
13
|
+
- its docstring is dropped;
|
|
14
|
+
- every non-builtin name becomes a single token, `v`;
|
|
15
|
+
- attribute names, builtins, AST node types, operators and short literals are kept.
|
|
16
|
+
|
|
17
|
+
The token stream is cut into 4-token shingles, and each shingle is hashed to 64 bits
|
|
18
|
+
(CRC32 token ids mixed with an FNV multiplier, vectorized in numpy). Each function
|
|
19
|
+
is stored as a sorted unique `uint64` array.
|
|
20
|
+
|
|
21
|
+
Module-level `NAME = literal` assignments are indexed as constants. Lists and sets
|
|
22
|
+
are canonicalized as sorted tuples.
|
|
23
|
+
|
|
24
|
+
A distribution's index is cached in a pickle. The cache key covers the index
|
|
25
|
+
parameters and the size and mtime of every file in the distribution, so upgrading or
|
|
26
|
+
editing a dependency re-indexes it.
|
|
27
|
+
|
|
28
|
+
## Public names
|
|
29
|
+
|
|
30
|
+
`from M import name` statements at module level are recorded, including those in
|
|
31
|
+
`if TYPE_CHECKING:` and `try` blocks, and filtered by `__all__` when the module
|
|
32
|
+
defines one. Each definition is named by the shortest public module that re-exports
|
|
33
|
+
it, directly or through a chain. For example, `jennings.coverage._core:call` is
|
|
34
|
+
reported as `jennings.coverage:call`.
|
|
35
|
+
|
|
36
|
+
A definition is public when:
|
|
37
|
+
- its qualified name has no `_private` component;
|
|
38
|
+
- it is not nested in a function;
|
|
39
|
+
- its module path, after re-export resolution, has no private component.
|
|
40
|
+
|
|
41
|
+
Only public definitions are reported unless `private = true`.
|
|
42
|
+
|
|
43
|
+
## Function matching
|
|
44
|
+
|
|
45
|
+
Two relations are reported:
|
|
46
|
+
|
|
47
|
+
- **copy**: the Jaccard similarity of the two shingle sets is at least `copy` (0.45).
|
|
48
|
+
- **inlined**: at least `inlined` (0.70) of a library function's shingles occur in a
|
|
49
|
+
project function, and the library function has at least `min-inlined` (30) shingles.
|
|
50
|
+
|
|
51
|
+
The join over all project and library pairs is exact. It uses prefix filtering, as in
|
|
52
|
+
the AllPairs/PPJoin set-similarity joins:
|
|
53
|
+
1. Shingles are ordered by ascending document frequency over the project and the
|
|
54
|
+
library together.
|
|
55
|
+
2. A pair can only reach Jaccard `t` if both sets' prefixes of length
|
|
56
|
+
`|x| - ceil(t|x|) + 1` share a shingle.
|
|
57
|
+
3. A library set can only be `t`-contained in a project set if its own prefix shares
|
|
58
|
+
one with the project set.
|
|
59
|
+
|
|
60
|
+
Both prefix products are sparse matrix products (scipy). A length filter removes
|
|
61
|
+
pairs whose sizes cannot qualify, and the surviving candidates are scored exactly
|
|
62
|
+
with chunked sparse row products.
|
|
63
|
+
|
|
64
|
+
A project function is reported only when its qualifying pairs identify a single
|
|
65
|
+
library shape. The shape count is taken over all indexed code, private included.
|
|
66
|
+
Library functions with identical shingle sets count as one shape. A generic shape,
|
|
67
|
+
such as a two-line wrapper that unpacks a tuple and forwards it to a call, matches
|
|
68
|
+
many library functions, so it carries no evidence of copying any one of them.
|
|
69
|
+
`ambiguous = true` reports these matches too.
|
|
70
|
+
|
|
71
|
+
## Constant matching
|
|
72
|
+
|
|
73
|
+
A project constant matches when either of these holds:
|
|
74
|
+
- a public library constant has the same name and value;
|
|
75
|
+
- a public library collection of 3 or more items has the same value under any name.
|
|
76
|
+
|
|
77
|
+
Collections that are an arithmetic progression of integers (`range` values) never
|
|
78
|
+
match by value alone.
|
|
79
|
+
|
|
80
|
+
## Semantic ranking (`pysayme rank`)
|
|
81
|
+
|
|
82
|
+
`rank` is a research aid for duplicates written in a different shape. It does not
|
|
83
|
+
gate. Each function's features are:
|
|
84
|
+
|
|
85
|
+
- `sym:`: dependency-defined names and attributes it references, plus raw literals
|
|
86
|
+
equal to a public dependency constant (`0x4C` → `JMP`);
|
|
87
|
+
- `lit:`: distinctive literals;
|
|
88
|
+
- `ex:`: hashes of normalized expression subtrees (4 or more nodes, commutative
|
|
89
|
+
operands sorted).
|
|
90
|
+
|
|
91
|
+
Features are TF-IDF weighted. IDF is taken over every library and project function.
|
|
92
|
+
|
|
93
|
+
Each public library function is scored at call depths 0 to `--depth`, and its best
|
|
94
|
+
depth counts. Depth `d` adds the features of the same-distribution functions reached
|
|
95
|
+
through `d` unambiguous calls, so a thin entry point that delegates to private
|
|
96
|
+
helpers is compared by what the helpers do.
|
|
97
|
+
|
|
98
|
+
Scores are cosine similarities from chunked sparse products.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# CI and releasing
|
|
2
|
+
|
|
3
|
+
## CI
|
|
4
|
+
|
|
5
|
+
`.github/workflows/ci.yml` runs on pushes to `main` and on pull requests:
|
|
6
|
+
|
|
7
|
+
- **lint**: `black --check` and `pylint` over `src` and `tests`.
|
|
8
|
+
- **test**: `pytest`, with xdist and coverage of at least 85%, on Python 3.12–3.14.
|
|
9
|
+
pysayme's own `[tool.pysayme]` table makes the suite gate pysayme against its
|
|
10
|
+
own dependencies.
|
|
11
|
+
- **build**: builds the sdist and wheel, runs `twine check --strict`, and runs the
|
|
12
|
+
wheel's console script.
|
|
13
|
+
|
|
14
|
+
Dependabot updates `uv.lock` and the workflow actions weekly.
|
|
15
|
+
|
|
16
|
+
## Releasing to PyPI
|
|
17
|
+
|
|
18
|
+
Versions come from git tags (hatch-vcs).
|
|
19
|
+
|
|
20
|
+
`.github/workflows/release.yml` builds and publishes when a GitHub release is
|
|
21
|
+
published. It uses PyPI trusted publishing (OIDC), so no API token is stored.
|
|
22
|
+
|
|
23
|
+
One-time setup:
|
|
24
|
+
|
|
25
|
+
1. On PyPI, add a trusted publisher for the project `pysayme`. If the project does
|
|
26
|
+
not exist yet, add it as a pending publisher. Use these values:
|
|
27
|
+
- owner: `anarkiwi`
|
|
28
|
+
- repository: `pysayme`
|
|
29
|
+
- workflow: `release.yml`
|
|
30
|
+
- environment: `pypi`
|
|
31
|
+
2. On GitHub, create the environment `pypi` under Settings → Environments.
|
|
32
|
+
Optionally, restrict it to tags and require reviewers.
|
|
33
|
+
|
|
34
|
+
To release, tag and publish a release:
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
git tag v0.1.0 && git push origin v0.1.0
|
|
38
|
+
gh release create v0.1.0 --generate-notes
|
|
39
|
+
```
|