python-betterproto icon indicating copy to clipboard operation
python-betterproto copied to clipboard

Generated code has non-existent relative import

Open yc2984 opened this issue 1 year ago • 3 comments

Summary

from .google import protobuf which doesn't exist

Reproduction Steps

I’m facing an issue with the imported packages, my protofile has some import like this:

syntax = "proto3";

package mypackage;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/field_mask.proto";
import "google/api/resource.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";
//import "validate/validate.proto";
import "protoc-gen-openapiv2/options/annotations.proto";

I’m running the code generation with buf:

version: v1
managed:
  enabled: true
plugins:
# Python
- plugin: buf.build/community/danielgtaylor-betterproto:v1.2.5
  out: _gen/pythonbproto2

and the command to run it is: buf generate --template buf.gen.additional.yaml --include-imports The generated files are like this:

tree mypackage/api/proto/_gen/pythonbproto2

├── __init__.py
├── google
│   ├── __init__.py
│   └── api.py
├── grpc
│   ├── __init__.py
│   └── gateway
│       ├── __init__.py
│       └── protoc_gen_openapiv2
│           ├── __init__.py
│           └── options.py
└── mypackage

However the generated file mypackage.py is expecting a relative dir called google.protobuf which couldn’t be found, it has only the api.py not protobuf. from .google import protobuf

Expected Results

The imported packages are properly handled. In the normal protoc way of generation, google.protobuf is a package and is imported directly like this: from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2

Actual Results

A relative import which doesn't exist: from .google import protobuf

System Information

protoc --version libprotoc 24.3

buf --version 1.21.0

version: v1
managed:
  enabled: true
plugins:
# Python
- plugin: buf.build/community/danielgtaylor-betterproto:v1.2.5
  out: _gen/pythonbproto2

I'm not able to use normal command line to generate this:

protoc -I . --python_betterproto_out=lib mypackage.proto 
google/api/annotations.proto: File not found.
google/api/client.proto: File not found.
google/api/field_behavior.proto: File not found.
google/api/resource.proto: File not found.
protoc-gen-openapiv2/options/annotations.proto: File not found.
mypackage.proto:5:1: Import "google/api/annotations.proto" was not found or had errors.
mypackage.proto:6:1: Import "google/api/client.proto" was not found or had errors.
mypackage.proto:7:1: Import "google/api/field_behavior.proto" was not found or had errors.
mypackage.proto:9:1: Import "google/api/resource.proto" was not found or had errors.
mypackage.proto:13:1: Import "protoc-gen-openapiv2/options/annotations.proto" was not found or had errors.

Checklist

  • [X] I have searched the issues for duplicates.
  • [X] I have shown the entire traceback, if possible.
  • [] I have verified this issue occurs on the latest prelease of betterproto which can be installed using pip install -U --pre betterproto, if possible.

yc2984 avatar Jan 31 '24 11:01 yc2984

I'm also having same issue.

realchandan avatar Feb 29 '24 02:02 realchandan

Try generating against the latest commit of this repository, I read somewhere that the latest commit doesn't have this issue but I haven't had time yet to try this.

If it does solve the issue: I do wonder what we can do to about pushing a new version to pip, to include those improvements without having to anchor my dependencies against a specific git hash.

BRUHItsABunny avatar Mar 02 '24 07:03 BRUHItsABunny

I tested with 1f88b67 which found the same issues. My process:

$ poetry add git+https://github.com/danielgtaylor/python-betterproto.git#1f88b67
Updating dependencies
Resolving dependencies... (0.2s)

Package operations: 0 installs, 1 update, 1 removal

  - Removing stringcase (1.2.0)
  - Updating betterproto (1.2.5 -> 2.0.0b6 1f88b67)

Writing lock file

# {target}.proto has a local proto dependency
$ buf generate --template ../../buf.gen.yaml --path ./{target}.proto -o {path_to_output_dir}

Upon reviewing the output, I see the dependency referenced using from .depproto.package import v1 when depproto is in the parent directory and would only work if it was from ..depproto.package import v1.

I've confirmed that my poetry.lock shows:

[package.source]
type = "git"
url = "https://github.com/danielgtaylor/python-betterproto.git"
reference = "1f88b67"
resolved_reference = "1f88b67eeb9871d33da154fd2c859b9d1aed62c1"

And the file protoc-gen-python_betterproto in my path was touched at the same timestamp as when I ran the poetry add command. I could not figure out how to get the binary to spit out its own version, but I'm pretty confident I'm using the latest SHA (at the time of this post).

placer14 avatar May 21 '24 15:05 placer14