Arguments, Keywords and Parameter Abstraction

[jshcodes]

Hi everyone!

We introduced some cool new functionality in FalconPy v0.5.4, called parameter abstraction. This feature abstracts the handling of the parameters dictionary by updating the Service Classes to support passing keywords to specify query string parameters instead.

Please note: This functionality impacts Service Class methods that make use of the parameters dictionary (query string) only.

Example

The old way

from falconpy.detects import Detects
falcon = Detects(creds={"client_id": "CLIENT_ID_HERE", "client_secret": "CLIENT_SECRET_HERE"})

parameter_payload = {
    "limit": 10,
    "sort": "first_behavior|asc"
    }

result = falcon.QueryDetects(parameters=parameter_payload)
print(result)

The new way

from falconpy.detects import Detects
falcon = Detects(creds={"client_id": "CLIENT_ID_HERE", "client_secret": "CLIENT_SECRET_HERE"})

result = falcon.QueryDetects(limit=10, sort="first_behavior|asc")
print(result)

Please note: We will also always support providing a parameter dictionary as opposed to individual keywords for Service Class methods using query string parameters.

As pointed out by issue #263, this had a potential negative impact for developers using arguments instead of keywords to specify values to Service Class methods. With the v0.6.0 update, we have attempted to speak to this issue.

• Keywords are still the preferred method for providing values to Service Class methods. This will always work.
• For methods that are impacted by the parameter abstraction change, and only ingest one (or one required) parameter, an additional helper has been implemented to try and "assume" the provided argument (if present).
  • Typically this will be the one "required" parameter. (Example: ids)
  • If there is only one parameter, regardless of required status, this will also be used.
• For methods requiring more than one parameter, that are also impacted by this change, developers must use keywords. Arguments are not supported.

If you have any questions or feedback about this new functionality, please reply here, or post a new topic. If you encounter a problem, where this functionality is not working as expected, please let us know by posting an issue.