Skip to content

Remove pipenv install from Makefile #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
May 7, 2025
Merged

Remove pipenv install from Makefile #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
182d1ab
re2
May 6, 2025
4a3be80
Override matches with re2 implementation
May 6, 2025
5a56dc1
pipenv
May 6, 2025
9d9669a
pipenv
May 6, 2025
8b4fd17
pipenv
May 6, 2025
6522bbd
Stubs
May 6, 2025
f9f1fb9
Stubs
May 6, 2025
f946b5a
Install pip and pipenv
May 6, 2025
ae3e3df
Update
May 6, 2025
84622a6
Remove re2
May 7, 2025
d0e9b08
sync
May 7, 2025
b0214bc
toml
May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,12 @@ git clone git@github.com:bufbuild/protovalidate-python.git
cd protovalidate-python
```

Then, make any changes you'd like. We use a Makefile to test and lint our code,
so you'll need a few non-Python tools:
Next, install dependencies. You will need:

* Python >=v3.9
* [Pipenv](https://pipenv.pypa.io/en/latest/index.html)

We use a Makefile to test and lint our code, so you'll also need a few non-Python tools:

* GNU Make (to use the Makefile): part of the `build-essential` package on
Debian-derived Linux distributions (including Ubuntu), and part of
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ jobs:
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: "pipenv"
- run: ${{steps.python.outputs.python-path}} -m pip install --upgrade pip pipenv
- name: Execute tests
run: make test PYTHON=${{ steps.python.outputs.python-path }}
- name: Lint
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/conformance.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,7 @@ jobs:
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: "pipenv"
- run: ${{steps.python.outputs.python-path}} -m pip install --upgrade pip pipenv
- name: Test conformance
run: make conformance PYTHON=${{ steps.python.outputs.python-path }}
1 change: 0 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ lint: install ## Lint code

.PHONY: install
install: ## Install dependencies
$(PYTHON) -m pip install --upgrade pip pipenv
pipenv --python $(PYTHON) sync --dev

.PHONY: checkgenerate
Expand Down
2 changes: 1 addition & 1 deletion Pipfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ protobuf = "==6.*"
pytest = "*"
mypy = "*"
ruff = "*"
types-protobuf = "*"
Copy link
Member

@stefanvanburen stefanvanburen Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@smaye81 did we have a reason for pinning to this version? Wasn't sure if we needed this for something or if newer types-protobuf versions were borked in some way.

I'm guessing it's because unpinning results in:

$ make lint
pipenv --python python3 sync --dev
Loading .env environment variables...
To activate this project's virtualenv, run pipenv shell.
Alternatively, run a command inside the virtualenv with pipenv run.
Installing dependencies from Pipfile.lock (8a53a8)...
Installing dependencies from Pipfile.lock (8a53a8)...
All dependencies are now up-to-date!
pipenv run ruff format --check --diff protovalidate tests
Loading .env environment variables...
16 files already formatted
pipenv run mypy protovalidate
Loading .env environment variables...
protovalidate/internal/rules.py:69: error: Incompatible types in assignment (expression has type "google.protobuf.descriptor.Descriptor | google._upb._message.Descriptor", variable has type "google.protobuf.descriptor.Descriptor")  [assignment]
protovalidate/validator.py:88: error: Argument 1 to "get" of "RuleFactory" has incompatible type "google.protobuf.descriptor.Descriptor | google._upb._message.Descriptor"; expected "google.protobuf.descriptor.Descriptor"  [arg-type]
Found 2 errors in 2 files (checked 9 source files)
make: *** [lint] Error 1

for when we want context in the future.

Copy link
Contributor Author

@smaye81 smaye81 Jun 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, that's why it's pinned. For some reason, that version is out of sync with the protobuf library and expects descriptors to be a union type.

types-protobuf = "==6.30.2.20250503"
exceptiongroup = "*"
tomli = "*"

Expand Down
38 changes: 19 additions & 19 deletions Pipfile.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ build-backend = "hatchling.build"
name = "protovalidate"
description = "Protocol Buffer Validation for Python"
readme = "README.md"
license = { file = "LICENSE" }
license-expression = "Apache 2.0"
license-file = "LICENSE"
keywords = ["validate", "protobuf", "protocol buffer"]
requires-python = ">=3.9"
classifiers = [
Expand All @@ -15,7 +16,6 @@ classifiers = [
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
"Typing :: Typed",
]
Expand Down
Loading