Skip to content
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

Jump to bottom

NO-JIRA: Updated doc for protoc command #2076

Closed
wants to merge 2 commits into from
Closed

NO-JIRA: Updated doc for protoc command #2076

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b77f87
NO-JIRA: Updated doc for protoc command
joke1196 Oct 15, 2024
b522e96
Added more information to the README
joke1196 Oct 28, 2024
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
16 changes: 13 additions & 3 deletions python-frontend/typeshed_serializer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
To run:
# Commands

in `python-frontend/src/main/protobuf` directory, run: ```protoc -I=. --python_out=../../../typeshed_serializer/serializer/proto_out ./symbols.proto```
## Generating the binaries for the typeshed and custom stubs:

in `python-frontend/typeshed_serializer` directory, run:
```./build-with-docker```

if for any reason the checksum are not different and the re-generation of the binaries does not start,
remove the checksum file. It will be re-generated.

## Updating the protobuf schemas:

in `python-frontend/src/main/protobuf` directory, run:
Copy link
Contributor

Choose a reason for hiding this comment

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

What does this do? Do we need it?
On my side I had some issues with Protobuf but eventually manage to sort them, and I didn't need to run a different command.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had an issue with the proto3_optional on my side, but it could be related to my version of the protobuf compiler. If you can generate the Python files without errors and without the flag then we should not bother changing the command.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah I had issues as well and after reinstalling it, it went fine. I suggest we close the PR if it's fine for you as well (unless the added command has intrinsic benefits you identified).

```protoc -I=. --python_out=../../../typeshed_serializer/serializer/proto_out ./symbols.proto```

```pip install -r requirements.txt```