Development: Add missing type hints #221

DetachHead · 2022-05-08T10:18:34Z

mypy was treating these as Any

priitlatt

I pulled latest changes from current tip of master into your fork and checked types with mypy. It reveals quite a few errors with the proposed changes. See the full mypy log below.

I'm afraid it needs some more work as of now.

Static code analysios results

Output of

MYPYPATH=stubs pipenv run mypy src/codemagic --pretty --show-error-context

is as follows:

src/codemagic/apple/resources/pre_release_version.py: note: In class "PreReleaseVersion":
src/codemagic/apple/resources/pre_release_version.py:16: error: Name "Optional"
is not defined
        relationships: Optional[Relationships] = None
                       ^
src/codemagic/apple/resources/pre_release_version.py:16: note: Did you forget to import it from "typing"? (Suggestion: "from typing import Optional")
src/codemagic/apple/resources/bundle_id_capability.py: note: In class "BundleIdCapability":
src/codemagic/apple/resources/bundle_id_capability.py:53: error: Incompatible
types in assignment (expression has type
"Optional[codemagic.apple.resources.bundle_id_capability.BundleIdCapability.Relationships]",
base class "Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/bundle_id.py: note: In class "BundleId":
src/codemagic/apple/resources/bundle_id.py:16: error: Name "Optional" is not
defined
        relationships: Optional[Relationships] = None
                       ^
src/codemagic/apple/resources/bundle_id.py:16: note: Did you forget to import it from "typing"? (Suggestion: "from typing import Optional")
src/codemagic/apple/resources/build.py: note: In class "Build":
src/codemagic/apple/resources/build.py:30: error: Incompatible types in
assignment (expression has type
"Optional[codemagic.apple.resources.build.Build.Relationships]", base class
"Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/beta_group.py: note: In class "BetaGroup":
src/codemagic/apple/resources/beta_group.py:17: error: Incompatible types in
assignment (expression has type
"Optional[codemagic.apple.resources.beta_group.BetaGroup.Relationships]", base
class "Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/beta_build_localization.py: note: In class "BetaBuildLocalization":
src/codemagic/apple/resources/beta_build_localization.py:17: error:
Incompatible types in assignment (expression has type
"Optional[codemagic.apple.resources.beta_build_localization.BetaBuildLocalization.Relationships]",
base class "Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/beta_app_review_submission.py: note: In class "BetaAppReviewSubmission":
src/codemagic/apple/resources/beta_app_review_submission.py:18: error:
Incompatible types in assignment (expression has type
"Optional[codemagic.apple.resources.beta_app_review_submission.BetaAppReviewSubmission.Relationships]",
base class "Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/beta_app_review_detail.py: note: In class "BetaAppReviewDetail":
src/codemagic/apple/resources/beta_app_review_detail.py:16: error: Incompatible
types in assignment (expression has type
"Optional[codemagic.apple.resources.beta_app_review_detail.BetaAppReviewDetail.Relationships]",
base class "Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/beta_app_localization.py: note: In class "BetaAppLocalization":
src/codemagic/apple/resources/beta_app_localization.py:17: error: Incompatible
types in assignment (expression has type
"Optional[codemagic.apple.resources.beta_app_localization.BetaAppLocalization.Relationships]",
base class "Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/app_store_version_localization.py: note: In class "AppStoreVersionLocalization":
src/codemagic/apple/resources/app_store_version_localization.py:17: error:
Incompatible types in assignment (expression has type
"Optional[codemagic.apple.resources.app_store_version_localization.AppStoreVersionLocalization.Relationships]",
base class "Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/app_store_version.py: note: In class "AppStoreVersion":
src/codemagic/apple/resources/app_store_version.py:20: error: Incompatible
types in assignment (expression has type
"Optional[codemagic.apple.resources.app_store_version.AppStoreVersion.Relationships]",
base class "Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/app.py: note: In class "App":
src/codemagic/apple/resources/app.py:18: error: Incompatible types in
assignment (expression has type
"Optional[codemagic.apple.resources.app.App.Relationships]", base class
"Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/signing_certificate.py: note: In class "SigningCertificate":
src/codemagic/apple/resources/signing_certificate.py:23: error: Incompatible
types in assignment (expression has type
"Optional[codemagic.apple.resources.signing_certificate.SigningCertificate.Relationships]",
base class "Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/resources/profile.py: note: In class "Profile":
src/codemagic/apple/resources/profile.py:22: error: Incompatible types in
assignment (expression has type
"Optional[codemagic.apple.resources.profile.Profile.Relationships]", base class
"Resource" defined the type as
"codemagic.apple.resources.resource.Resource.Relationships")
        relationships: Optional[Relationships] = None
                                                 ^
src/codemagic/apple/app_store_connect/versioning/app_store_versions.py: note: In member "read_build" of class "AppStoreVersions":
src/codemagic/apple/app_store_connect/versioning/app_store_versions.py:104: error:
Item "None" of "Optional[Relationships]" has no attribute "build"
                url = app_store_version.relationships.build.links.related
                      ^
src/codemagic/apple/app_store_connect/versioning/app_store_versions.py:107: error:
Argument 1 to "get" of "Session" has incompatible type "Union[str, None, Any]";
expected "Union[str, bytes]"
            response = self.client.session.get(url).json()
                                               ^
src/codemagic/apple/app_store_connect/versioning/app_store_versions.py: note: In member "read_app_store_version_submission" of class "AppStoreVersions":
src/codemagic/apple/app_store_connect/versioning/app_store_versions.py:121: error:
Item "None" of "Optional[Relationships]" has no attribute
"appStoreVersionSubmission"
                url = app_store_version.relationships.appStoreVersionSubmi...
                      ^
src/codemagic/apple/app_store_connect/versioning/app_store_versions.py:124: error:
Argument 1 to "get" of "Session" has incompatible type "Union[str, None, Any]";
expected "Union[str, bytes]"
            response = self.client.session.get(url).json()
                                               ^
src/codemagic/apple/app_store_connect/versioning/app_store_versions.py: note: In member "list_app_store_version_localizations" of class "AppStoreVersions":
src/codemagic/apple/app_store_connect/versioning/app_store_versions.py:135: error:
Item "None" of "Optional[Relationships]" has no attribute
"appStoreVersionLocalizations"
                url = app_store_version.relationships.appStoreVersionLocal...
                      ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py: note: In member "read_bundle_id" of class "Profiles":
src/codemagic/apple/app_store_connect/provisioning/profiles.py:113: error: Item
"None" of "Optional[Relationships]" has no attribute "bundleId"
                url = profile.relationships.bundleId.links.related
                      ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py:116: error:
Argument 1 to "get" of "Session" has incompatible type "Union[str, None, Any]";
expected "Union[str, bytes]"
            response = self.client.session.get(url).json()
                                               ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py: note: In member "get_bundle_id_resource_id" of class "Profiles":
src/codemagic/apple/app_store_connect/provisioning/profiles.py:124: error: Item
"None" of "Optional[Relationships]" has no attribute "bundleId"
                url = profile.relationships.bundleId.links.self
                      ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py:127: error:
Argument 1 to "get" of "Session" has incompatible type "Union[str, None, Any]";
expected "Union[str, bytes]"
            response = self.client.session.get(url).json()
                                               ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py: note: In member "list_certificates" of class "Profiles":
src/codemagic/apple/app_store_connect/provisioning/profiles.py:135: error: Item
"Relationships" of "Optional[Relationships]" has no attribute "profiles"
                url = profile.relationships.profiles.links.related
                      ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py:135: error: Item
"None" of "Optional[Relationships]" has no attribute "profiles"
                url = profile.relationships.profiles.links.related
                      ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py: note: In member "list_certificate_ids" of class "Profiles":
src/codemagic/apple/app_store_connect/provisioning/profiles.py:145: error: Item
"None" of "Optional[Relationships]" has no attribute "certificates"
                url = profile.relationships.certificates.links.self
                      ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py: note: In member "list_devices" of class "Profiles":
src/codemagic/apple/app_store_connect/provisioning/profiles.py:155: error: Item
"Relationships" of "Optional[Relationships]" has no attribute "profiles"
                url = profile.relationships.profiles.links.related
                      ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py:155: error: Item
"None" of "Optional[Relationships]" has no attribute "profiles"
                url = profile.relationships.profiles.links.related
                      ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py: note: In member "list_device_ids" of class "Profiles":
src/codemagic/apple/app_store_connect/provisioning/profiles.py:165: error: Item
"Relationships" of "Optional[Relationships]" has no attribute "profiles"
                url = profile.relationships.profiles.links.self
                      ^
src/codemagic/apple/app_store_connect/provisioning/profiles.py:165: error: Item
"None" of "Optional[Relationships]" has no attribute "profiles"
                url = profile.relationships.profiles.links.self
                      ^
src/codemagic/apple/app_store_connect/builds/builds.py: note: In member "read_app" of class "Builds":
src/codemagic/apple/app_store_connect/builds/builds.py:77: error: Item "None"
of "Optional[Relationships]" has no attribute "app"
                url = build.relationships.app.links.related
                      ^
src/codemagic/apple/app_store_connect/builds/builds.py:80: error: Argument 1 to
"get" of "Session" has incompatible type "Union[str, None, Any]"; expected
"Union[str, bytes]"
            response = self.client.session.get(url).json()
                                               ^
src/codemagic/apple/app_store_connect/builds/builds.py: note: In member "read_app_store_version" of class "Builds":
src/codemagic/apple/app_store_connect/builds/builds.py:88: error: Item "None"
of "Optional[Relationships]" has no attribute "appStoreVersion"
                url = build.relationships.appStoreVersion.links.related
                      ^
src/codemagic/apple/app_store_connect/builds/builds.py:91: error: Argument 1 to
"get" of "Session" has incompatible type "Union[str, None, Any]"; expected
"Union[str, bytes]"
            response = self.client.session.get(url).json()
                                               ^
src/codemagic/apple/app_store_connect/builds/builds.py: note: In member "read_pre_release_version" of class "Builds":
src/codemagic/apple/app_store_connect/builds/builds.py:101: error: Item "None"
of "Optional[Relationships]" has no attribute "preReleaseVersion"
                url = build.relationships.preReleaseVersion.links.related
                      ^
src/codemagic/apple/app_store_connect/builds/builds.py:104: error: Argument 1
to "get" of "Session" has incompatible type "Union[str, None, Any]"; expected
"Union[str, bytes]"
            response = self.client.session.get(url).json()
                                               ^
src/codemagic/apple/app_store_connect/apps/apps.py: note: In member "list_builds" of class "Apps":
src/codemagic/apple/app_store_connect/apps/apps.py:81: error: Item "None" of
"Optional[Relationships]" has no attribute "builds"
                url = app.relationships.builds.links.related
                      ^
src/codemagic/apple/app_store_connect/apps/apps.py: note: In member "list_pre_release_versions" of class "Apps":
src/codemagic/apple/app_store_connect/apps/apps.py:91: error: Item "None" of
"Optional[Relationships]" has no attribute "preReleaseVersions"
                url = app.relationships.preReleaseVersions.links.related
                      ^
src/codemagic/apple/app_store_connect/apps/apps.py: note: In member "list_app_store_versions" of class "Apps":
src/codemagic/apple/app_store_connect/apps/apps.py:106: error: Item "None" of
"Optional[Relationships]" has no attribute "appStoreVersions"
                url = app.relationships.appStoreVersions.links.related
                      ^
src/codemagic/apple/app_store_connect/apps/apps.py: note: In member "list_beta_app_localizations" of class "Apps":
src/codemagic/apple/app_store_connect/apps/apps.py:118: error: Item "None" of
"Optional[Relationships]" has no attribute "betaAppLocalizations"
                url = app.relationships.betaAppLocalizations.links.related
                      ^
src/codemagic/apple/app_store_connect/apps/apps.py:121: error: Argument 1 to
"get" of "Session" has incompatible type "Union[str, None, Any]"; expected
"Union[str, bytes]"
            response = self.client.session.get(url).json()
                                               ^
src/codemagic/apple/app_store_connect/apps/apps.py: note: In member "read_beta_app_review_detail" of class "Apps":
src/codemagic/apple/app_store_connect/apps/apps.py:129: error: Item "None" of
"Optional[Relationships]" has no attribute "betaAppReviewDetail"
                url = app.relationships.betaAppReviewDetail.links.related
                      ^
src/codemagic/apple/app_store_connect/apps/apps.py:132: error: Argument 1 to
"get" of "Session" has incompatible type "Union[str, None, Any]"; expected
"Union[str, bytes]"
            response = self.client.session.get(url).json()
                                               ^
src/codemagic/tools/universal_apk_generator.py: note: In member "generate" of class "UniversalApkGenerator":
src/codemagic/tools/universal_apk_generator.py:116: error: Argument 2 to
"build_universal_apks" of "AndroidAppBundle" has incompatible type
"**Dict[str, object]"; expected "Optional[Path]"
    ...dAppBundle().build_universal_apks(self.pattern, **signing_info_kwargs)
                                                         ^
src/codemagic/tools/universal_apk_generator.py:116: error: Argument 2 to
"build_universal_apks" of "AndroidAppBundle" has incompatible type
"**Dict[str, object]"; expected "Union[str, KeystorePassword, None]"
    ...dAppBundle().build_universal_apks(self.pattern, **signing_info_kwargs)
                                                         ^
src/codemagic/tools/universal_apk_generator.py:116: error: Argument 2 to
"build_universal_apks" of "AndroidAppBundle" has incompatible type
"**Dict[str, object]"; expected "Union[str, KeyAlias, None]"
    ...dAppBundle().build_universal_apks(self.pattern, **signing_info_kwargs)
                                                         ^
src/codemagic/tools/universal_apk_generator.py:116: error: Argument 2 to
"build_universal_apks" of "AndroidAppBundle" has incompatible type
"**Dict[str, object]"; expected "Union[str, KeyPassword, None]"
    ...dAppBundle().build_universal_apks(self.pattern, **signing_info_kwargs)
                                                         ^
src/codemagic/tools/_app_store_connect/action_groups/beta_app_review_submissions_action_group.py: note: In class "BetaAppReviewSubmissionsActionGroup":
src/codemagic/tools/_app_store_connect/action_groups/beta_app_review_submissions_action_group.py:21: error:
Return type "AppStoreVersionSubmission" of "create_beta_app_review_submission"
incompatible with return type "BetaAppReviewSubmission" in supertype
"AbstractBaseAction"
                    BuildArgument.BUILD_ID_RESOURCE_ID,
        ^
Found 48 errors in 20 files (checked 171 source files)

DetachHead · 2022-05-14T05:11:09Z

@priitlatt thanks, will try to fix those now

is there a reason the CI isn't running? i'm having trouble setting up the dependencies locally so i'd like to be able to rely on the CI checks

priitlatt · 2022-05-17T09:32:30Z

@DetachHead I've made some changes to the test workflow. Please get your fork up to date with the upstream and then you can enable Checks workflow which will be executed on push events.

DetachHead · 2022-05-18T08:35:45Z

@priitlatt done, though it looks like you have to approve the run since i'm a first-time contributor

priitlatt

Couple of notes.

Please revise attributes and relationships declarations in src/codemagic/apple/resources. Latest changes from upstream introduced some new resources there which are now lacking those. But there are some older resource definitions such as AppStoreVersionSubmission that do not define them either. I suppose we should persist a uniform design for these.
submit_to_app_store method in src/codemagic/tools/_app_store_connect/abstract_base_action.py has invalid return type.

src/codemagic/apple/app_store_connect/apps/apps.py

src/codemagic/apple/app_store_connect/provisioning/profiles.py

src/codemagic/cli/cli_app.py

src/codemagic/tools/universal_apk_generator.py

…ate_relationships`

…types that subtype them to work around the fact that the classes don't use generics

DetachHead · 2022-05-28T07:56:37Z

Please revise attributes and relationships declarations in src/codemagic/apple/resources. Latest changes from upstream introduced some new resources there which are now lacking those. But there are some older resource definitions such as AppStoreVersionSubmission that do not define them either. I suppose we should persist a uniform design for these.

i've made attributes and relationships abstract properties on Resource, so now mypy will enforce that all subclasses define them

submit_to_app_store method in src/codemagic/tools/_app_store_connect/abstract_base_action.py has invalid return type.

fixed, i guess it was always wrong but the error was hidden since the decorator was removing the types.

priitlatt

Couple of minor nitpicks are still remaining, but overall looks very good!

src/codemagic/apple/app_store_connect/provisioning/profiles.py

src/codemagic/apple/resources/resource.py

tests/apple/resources/mocks/certificate.json

tests/apple/resources/mocks/device.json

…ypy yet due to python/mypy#11117)

…fine their own `attributes` and `relationships` properties

priitlatt

Everything looks good now! 🚀 Thank you very much for the contribution and effort.

priitlatt · 2022-06-01T07:47:57Z

@DetachHead FYI, this is now released as part of version 0.27.1.

DetachHead changed the title ~~fix cli.action decorator removing the function type~~ add/fix some types May 9, 2022

priitlatt self-requested a review May 11, 2022 12:37

priitlatt requested changes May 12, 2022

View reviewed changes

DetachHead requested a review from priitlatt May 14, 2022 08:08

DetachHead force-pushed the master branch from 835f6c4 to 84493c7 Compare May 18, 2022 08:33

DetachHead force-pushed the master branch 2 times, most recently from 1e8fd59 to 669313b Compare May 26, 2022 09:54

priitlatt requested changes May 26, 2022

View reviewed changes

priitlatt changed the title ~~add/fix some types~~ Development: Add missing type hints May 26, 2022

DetachHead added 3 commits May 28, 2022 13:46

fix cli.action decorator removing the function type

a08026c

add return types for Resource._create_attributes and `Resource._cre…

d448c8a

…ate_relationships`

add attributes and relationships properties to all Resource sub…

667dd37

…types that subtype them to work around the fact that the classes don't use generics

DetachHead force-pushed the master branch 4 times, most recently from 70bba5b to 114b461 Compare May 28, 2022 04:46

DetachHead force-pushed the master branch 4 times, most recently from b60b163 to bfcf82d Compare May 29, 2022 00:31

DetachHead requested a review from priitlatt May 29, 2022 00:34

priitlatt requested changes May 30, 2022

View reviewed changes

DetachHead force-pushed the master branch 4 times, most recently from ab2643a to b06f426 Compare May 31, 2022 09:50

DetachHead added 7 commits May 31, 2022 20:17

fix mypy errors

245bd8d

add return type for common_arguments decorator (doesn't work with m…

020024f

…ypy yet due to python/mypy#11117)

fix common_arguments return type

678260e

fix return type for AbstractBaseAction.submit_to_app_store

e2d0e14

use abstract properties to enforce that all subtypes of Resource de…

50add2f

…fine their own `attributes` and `relationships` properties

make Resource an abstract class at runtime

9cfe702

fix tests

dff84af

DetachHead force-pushed the master branch from b06f426 to dff84af Compare May 31, 2022 10:18

fix methods in Profiles that take a Profile

260c612

DetachHead requested a review from priitlatt May 31, 2022 11:03

priitlatt approved these changes May 31, 2022

View reviewed changes

priitlatt merged commit 5058be6 into codemagic-ci-cd:master May 31, 2022

priitlatt added a commit that referenced this pull request May 31, 2022

Update changelog with changes from #221

32317cc

priitlatt mentioned this pull request May 31, 2022

Development: Add type hints to ResourceManagerMixin #235

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Development: Add missing type hints #221

Development: Add missing type hints #221

DetachHead commented May 8, 2022 •

edited

Loading

priitlatt left a comment

DetachHead commented May 14, 2022

priitlatt commented May 17, 2022

DetachHead commented May 18, 2022

priitlatt left a comment

DetachHead commented May 28, 2022

priitlatt left a comment

priitlatt left a comment

priitlatt commented Jun 1, 2022

Development: Add missing type hints #221

Development: Add missing type hints #221

Conversation

DetachHead commented May 8, 2022 • edited Loading

priitlatt left a comment

Choose a reason for hiding this comment

DetachHead commented May 14, 2022

priitlatt commented May 17, 2022

DetachHead commented May 18, 2022

priitlatt left a comment

Choose a reason for hiding this comment

DetachHead commented May 28, 2022

priitlatt left a comment

Choose a reason for hiding this comment

priitlatt left a comment

Choose a reason for hiding this comment

priitlatt commented Jun 1, 2022

DetachHead commented May 8, 2022 •

edited

Loading