search

palantir / conjure-python

Conjure generator for Python clients
Apache License 2.0
19 stars 18 forks source link

Make exports compliant with static checkers #786

Closed gsilvasimoesPT closed 9 months ago

gsilvasimoesPT commented 9 months ago

Before this PR

See modified test generated files for examples. The current generated bindings look like this:

from .._impl import (
    another_TestService as TestService,
)

Static checkers like pyright/pylance do not consider this to be an exported module, as it is not a redundant alias (there is a rename happening).

See: https://microsoft.github.io/pyright/#/typed-libraries?id=library-interface

Adding exported modules to __all__ resolves this issue and seems a good practice when renaming is happening.

After this PR

This PR adds exported modules to the __all__ export list.

==COMMIT_MSG== Make exports compliant with static checkers ==COMMIT_MSG==

Possible downsides?

None expected, all exported types and services should be added to __all__.

changelog-app[bot] commented 9 months ago

Generate changelog in changelog-dir>`changelog/@unreleased`</changelog-dir

What do the change types mean? - `feature`: A new feature of the service. - `improvement`: An incremental improvement in the functionality or operation of the service. - `fix`: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way. - `break`: Has the potential to break consumers of this service's API, inclusive of both Palantir services and external consumers of the service's API (e.g. customer-written software or integrations). - `deprecation`: Advertises the intention to remove service functionality without any change to the operation of the service itself. - `manualTask`: Requires the possibility of manual intervention (running a script, eyeballing configuration, performing database surgery, ...) at the time of upgrade for it to succeed. - `migration`: A fully automatic upgrade migration task with no engineer input required. _Note: only one type should be chosen._
How are new versions calculated? - ❗The `break` and `manual task` changelog types will result in a major release! - 🐛 The `fix` changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease. - ✨ All others will result in a minor version release.

Type

- [ ] Feature - [ ] Improvement - [x] Fix - [ ] Break - [ ] Deprecation - [ ] Manual task - [ ] Migration

Description

Make exports compliant with static checkers **Check the box to generate changelog(s)** - [x] Generate changelog entry
gsilvasimoesPT commented 9 months ago

Closing in favor of #787