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.

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

Add FFI type hinting #435

Closed
2 tasks done
JP-Ellis opened this issue Oct 26, 2023 · 1 comment · Fixed by #436
Closed
2 tasks done

Add FFI type hinting #435

JP-Ellis opened this issue Oct 26, 2023 · 1 comment · Fixed by #436
Assignees
Labels
area:v3 Relating to the pact.v3 module difficulty:easy A simple task appropriate for newcomers to the codebase smartbear-supported This issue is supported by SmartBear type:chore Part of regular code upkeep

Comments

@JP-Ellis
Copy link
Contributor

Have you read the Contributing Guidelines on issues?

Description

  • Add a _ffi.pyi with type hinting
  • Resolves typing issues which are likely to be discovered as a result.

Has this been requested on Canny?

No response

Motivation

The Rust FFI is wrapped by the Python CFFI package and a _ffi.cpython-*.so binary library is created. The binary library functions at runtime as a Python module, but obviously cannot be edited to add type hinting.

Instead, it is possible to add a _ffi.pyi file which provides type hinting in a separate file to the core implementation irrespective of whether the implementation being a Python text file, or a binary library.

Have you tried building it?

No response

Self-service

  • I'd be willing to contribute this feature to Pact Python myself.
@JP-Ellis JP-Ellis added smartbear-supported This issue is supported by SmartBear difficulty:easy A simple task appropriate for newcomers to the codebase area:v3 Relating to the pact.v3 module type:chore Part of regular code upkeep labels Oct 26, 2023
@JP-Ellis JP-Ellis moved this to 👀 In Review in Pact Python Oct 26, 2023
@github-actions
Copy link

🤖 Great news! We've labeled this issue as smartbear-supported and created a tracking ticket in PactFlow's Jira (PACT-1437). We'll keep work public and post updates here. Meanwhile, feel free to check out our docs. Thanks for your patience!

@JP-Ellis JP-Ellis mentioned this issue Oct 26, 2023
3 tasks
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Completed in Pact Python Oct 26, 2023
@JP-Ellis JP-Ellis self-assigned this Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:v3 Relating to the pact.v3 module difficulty:easy A simple task appropriate for newcomers to the codebase smartbear-supported This issue is supported by SmartBear type:chore Part of regular code upkeep
Projects
Status: ✅ Completed
Development

Successfully merging a pull request may close this issue.

1 participant