[ BUG ] Pylance throwing reportAttributeAccessIssue when using pythonic=True

[mew1033]

Describe the bug
When I set pythonic=True in my client and do a query, the response object doesn't appear to properly support type hinting.

To Reproduce

from falconpy import SpotlightVulnerabilities

CID = "client_id"
CSE = "client_secret"
FILTER_STR = "filter_string"

falcon = SpotlightVulnerabilities(client_id=CID, client_secret=CSE, pythonic=True)
res = falcon.query_vulnerabilities_combined(filter=FILTER_STR, limit=1)
rate_limit = res.ratelimit_remaining
resources = res.resources
after = res.after

The last three lines make Pylance unhappy. They say:

Cannot access attribute "ratelimit_remaining" for class "Dict[str, int | dict[Unknown, Unknown]]"
  Attribute "ratelimit_remaining" is unknownPylance[reportAttributeAccessIssue](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#reportAttributeAccessIssue)

Expected behavior
I expect VSCode/Pylance to find the appropriate symbols and be happy.

Environment (please complete the following information):

• OS: Ubuntu 22.04 in WSL 2
• Python: 3.12
• FalconPy: 1.4.6

[jshcodes]

Hi @mew1033 -

Thanks for reporting this issue!

If you type your result object, does the Pylance error go away? (Currently the type hint for the return of API operation methods do not speak to the pythonic Result object.)

from falconpy import SpotlightVulnerabilities, Result

CID = "client_id"
CSE = "client_secret"

filter_string = "whatevers"

falcon = SpotlightVulnerabilities(pythonic=True)

res: Result = falcon.query_vulnerabilities(filter=filter_string)

rate_limit = res.ratelimit_remaining
resources = res.resources
after = res.after

[mew1033]

Looks like it's still erroring for me:

[jshcodes]

Can you provide us a redacted version of your code so we can test? (Please remove any API keys and CID / AID values.)

[mew1033]

@jshcodes It actually looks like it does fix some of the errors. But it causes additional errors? Strange. Here's a code sample that uses the total, after, and resources properties:

from falconpy import SpotlightVulnerabilities, Result


API_ENDPOINT = "https://apiendpoint"
CLIENT_ID = "id"
CLIENT_SECRET = "secret"

falcon = SpotlightVulnerabilities(client_id=CLIENT_ID, client_secret=CLIENT_SECRET, pythonic=True)

filter_str = "filter_string"
results = []
total = 0
res = falcon.query_vulnerabilities_combined(filter=filter_str, limit=5000)
total += res.total
if (aft := res.after):
    while aft:
        res = falcon.query_vulnerabilities_combined(filter=filter_str, after=aft, limit=5000)
        results.extend(res.resources)
        aft = res.after