Skip to content

Commit 20ee7d2

Browse files
authored
Create pre-commit hook that checks Conda requirements (#596)
* Create pre-commit hook that checks Conda requirements * Fix pyiceberg requirements and add license
1 parent e751ec1 commit 20ee7d2

File tree

7 files changed

+336
-10
lines changed

7 files changed

+336
-10
lines changed

.pre-commit-config.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,10 @@ repos:
44
hooks:
55
- id: ruff
66
- id: ruff-format
7+
- repo: local
8+
hooks:
9+
- id: conda-requirements
10+
name: conda-requirements
11+
entry: python conda/requirements.py
12+
language: python
13+
files: ^(requirements\.txt|pyproject\.toml)$

LICENSES/LICENSE.pyiceberg

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.
203+
204+
--------------------------------------------------------------------------------
205+
206+
This product includes code from Apache Avro.
207+
208+
* Code for initializing the Avro (de)compression codecs
209+
* The Binary decoder for reading in an Avro byte stream
210+
211+
Copyright: 2014-2022 The Apache Software Foundation.
212+
Home page: https://avro.apache.org/
213+
License: https://www.apache.org/licenses/LICENSE-2.0
214+
215+
--------------------------------------------------------------------------------
216+
217+
This product includes code from Apache Thrift.
218+
219+
* Uses the fb303.thrift file that's part of Hive's thrift service in vendor/fb303/
220+
221+
Copyright: 2006-2022 The Apache Software Foundation.
222+
Home page: https://thrift.apache.org/
223+
License: https://www.apache.org/licenses/LICENSE-2.0
224+
225+
--------------------------------------------------------------------------------
226+
227+
This product includes code from Apache Hive.
228+
229+
* Uses hive_metastore.thrift to generate the Hive Metastore client in vendor/hive_metastore/
230+
231+
Copyright: 2008-2022 The Apache Software Foundation.
232+
Home page: https://hive.apache.org/
233+
License: https://www.apache.org/licenses/LICENSE-2.0
234+
235+
--------------------------------------------------------------------------------

conda/post-link.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
$PREFIX/bin/pip install \
44
'rocksdict>=0.3,<0.4' \
55
'protobuf>=5.27.2,<6.0' \
6-
'influxdb3-python>=0.7,<1.0'
6+
'influxdb3-python>=0.7,<1.0' \
7+
'pyiceberg[pyarrow,glue]>=0.7,<0.8'

conda/requirements.py

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
import re
2+
import sys
3+
from pathlib import Path
4+
5+
PYPI_OPTIONAL_GROUP = re.compile(r"all\s*=\s*\[\n(.*?)\n\]", re.DOTALL)
6+
PYPI_MAIN_REQUIREMENTS = re.compile(r"([\w\[\],-]+)([><=,.\d]*)?")
7+
PYPI_OPTIONAL_REQUIREMENTS = re.compile(r"([\w\[\],-]+)([><=,.\d]*)\",?")
8+
9+
CONDA_META_GROUP = re.compile(r"run:\n(.+)\ntest", re.DOTALL)
10+
CONDA_META_REQUIREMENTS = re.compile(r"\s{4}- ([\w-]+) ([><=,.\d]*)?")
11+
CONDA_POST_LINK_REQUIREMENTS = re.compile(r"'([\w\[\],-]+)([><=,.\d]*)?")
12+
13+
PYPI_TO_CONDA_NAME_MAPPING = {
14+
"confluent-kafka": "python-confluent-kafka",
15+
}
16+
17+
18+
def get_pypi_main_requirements(filename):
19+
text = Path(filename).read_text()
20+
result = PYPI_MAIN_REQUIREMENTS.findall(text)
21+
return result
22+
23+
24+
def get_pypi_optional_requirements(filename):
25+
text = Path(filename).read_text()
26+
text = PYPI_OPTIONAL_GROUP.search(text).group(1)
27+
result = PYPI_OPTIONAL_REQUIREMENTS.findall(text)
28+
return result
29+
30+
31+
def get_conda_meta_requirements(filename):
32+
text = Path(filename).read_text()
33+
text = CONDA_META_GROUP.search(text).group(1)
34+
result = CONDA_META_REQUIREMENTS.findall(text)
35+
return result
36+
37+
38+
def get_conda_post_link_requirements(filename):
39+
text = Path(filename).read_text()
40+
result = CONDA_POST_LINK_REQUIREMENTS.findall(text)
41+
return result
42+
43+
44+
if __name__ == "__main__":
45+
pypi_requirements = dict(
46+
get_pypi_main_requirements("requirements.txt")
47+
+ get_pypi_optional_requirements("pyproject.toml")
48+
)
49+
conda_requirements = dict(
50+
get_conda_meta_requirements("conda/meta.yaml")
51+
+ get_conda_post_link_requirements("conda/post-link.sh")
52+
)
53+
54+
# Conda specifies Python version alongside other requirements
55+
del conda_requirements["python"]
56+
57+
# Same packages may have different names in PyPI and Conda
58+
for pypi_name, conda_name in PYPI_TO_CONDA_NAME_MAPPING.items():
59+
pypi_requirements[conda_name] = pypi_requirements[pypi_name]
60+
del pypi_requirements[pypi_name]
61+
62+
if pypi_requirements != conda_requirements:
63+
missing_requirements = []
64+
differing_requirements = []
65+
for lib, pypi_version in pypi_requirements.items():
66+
if lib in conda_requirements:
67+
conda_version = conda_requirements[lib]
68+
if conda_version != pypi_version:
69+
differing_requirements.append((lib, pypi_version, conda_version))
70+
else:
71+
missing_requirements.append(lib)
72+
73+
print("PyPI and Conda requirements do not match.\n")
74+
75+
if differing_requirements:
76+
print("Differing requirements:")
77+
for lib, pypi_version, conda_version in differing_requirements:
78+
print(f"- {lib}")
79+
print(f" PyPI version: {pypi_version}")
80+
print(f" Conda version: {conda_version}")
81+
print()
82+
83+
if missing_requirements:
84+
formatted_missing_requirements = ", ".join(missing_requirements)
85+
print(f"Missing in Conda requirements: {formatted_missing_requirements}.")
86+
87+
sys.exit(1)

pyproject.toml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,14 @@ all = [
3131
"fastavro>=1.8,<2.0",
3232
"protobuf>=5.27.2,<6.0",
3333
"influxdb3-python>=0.7,<1.0",
34-
"pyarrow",
35-
"pyiceberg",
36-
"boto3",
37-
"mypy_boto3_glue",
34+
"pyiceberg[pyarrow,glue]>=0.7,<0.8",
3835
]
3936

4037
avro = ["fastavro>=1.8,<2.0"]
4138
protobuf = ["protobuf>=5.27.2,<6.0"]
4239
influxdb3 = ["influxdb3-python>=0.7,<1.0"]
43-
iceberg = ["pyarrow", "pyiceberg"]
44-
iceberg_aws = ["pyarrow", "pyiceberg", "boto3", "mypy_boto3_glue"]
40+
iceberg = ["pyiceberg[pyarrow]>=0.7,<0.8"]
41+
iceberg_aws = ["pyiceberg[pyarrow,glue]>=0.7,<0.8"]
4542

4643
[tool.setuptools.packages.find]
4744
include = ["quixstreams*"]

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
confluent-kafka>=2.2,<2.5
22
requests>=2.32
3-
rocksdict>=0.3, <0.4
3+
rocksdict>=0.3,<0.4
44
typing_extensions>=4.8
55
orjson>=3.9,<4
66
pydantic>=2.7,<2.10

tests/requirements.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,4 @@ docker>=7.1.0 # Required to use requests>=2.32
55
fastavro>=1.8,<2.0
66
protobuf>=5.27.2
77
influxdb3-python>=0.7.0,<1.0
8-
pyarrow
9-
pyiceberg
8+
pyiceberg[pyarrow,glue]>=0.7,<0.8

0 commit comments

Comments
 (0)