-
Notifications
You must be signed in to change notification settings - Fork 160
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
Fix/log invalid kwarg #238
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -40,6 +40,7 @@ | |
BE_GEO_ID, | ||
MERAKI_PYTHON_SDK_CALLER, | ||
USE_ITERATOR_FOR_GET_PAGES, | ||
ENABLE_KWARGS_VALIDATION, | ||
) | ||
from meraki.rest_session import * | ||
|
||
|
@@ -72,6 +73,7 @@ class DashboardAPI(object): | |
- be_geo_id (string): optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID | ||
- caller (string): optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER | ||
- use_iterator_for_get_pages (boolean): list* methods will return an iterator with each object instead of a complete list with all items | ||
- enable_kwarg_validation (boolean): enable kwargs validation? | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This makes sense and is necessary. |
||
""" | ||
|
||
def __init__(self, | ||
|
@@ -97,6 +99,7 @@ def __init__(self, | |
caller=MERAKI_PYTHON_SDK_CALLER, | ||
use_iterator_for_get_pages=USE_ITERATOR_FOR_GET_PAGES, | ||
inherit_logging_config=INHERIT_LOGGING_CONFIG, | ||
enable_kwarg_validation=ENABLE_KWARGS_VALIDATION, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This makes sense and seems necessary. |
||
): | ||
|
||
# Check API key | ||
|
@@ -167,20 +170,21 @@ def __init__(self, | |
use_iterator_for_get_pages=use_iterator_for_get_pages, | ||
) | ||
|
||
self._enable_kwargs_validation = enable_kwarg_validation | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should not be needed. None of the other config kwargs receive this treatment and we should not start treating kwargs this way. |
||
# API endpoints by section | ||
self.administered = Administered(self._session) | ||
self.organizations = Organizations(self._session) | ||
self.networks = Networks(self._session) | ||
self.devices = Devices(self._session) | ||
self.appliance = Appliance(self._session) | ||
self.camera = Camera(self._session) | ||
self.cellularGateway = CellularGateway(self._session) | ||
self.insight = Insight(self._session) | ||
self.licensing = Licensing(self._session) | ||
self.sensor = Sensor(self._session) | ||
self.sm = Sm(self._session) | ||
self.switch = Switch(self._session) | ||
self.wireless = Wireless(self._session) | ||
self.administered = Administered(self._session, self._enable_kwargs_validation ) | ||
self.organizations = Organizations(self._session, self._enable_kwargs_validation ) | ||
self.networks = Networks(self._session, self._enable_kwargs_validation ) | ||
self.devices = Devices(self._session, self._enable_kwargs_validation ) | ||
self.appliance = Appliance(self._session, self._enable_kwargs_validation ) | ||
self.camera = Camera(self._session, self._enable_kwargs_validation ) | ||
self.cellularGateway = CellularGateway(self._session, self._enable_kwargs_validation ) | ||
self.insight = Insight(self._session, self._enable_kwargs_validation ) | ||
self.licensing = Licensing(self._session, self._enable_kwargs_validation ) | ||
self.sensor = Sensor(self._session, self._enable_kwargs_validation ) | ||
self.sm = Sm(self._session, self._enable_kwargs_validation ) | ||
self.switch = Switch(self._session, self._enable_kwargs_validation ) | ||
self.wireless = Wireless(self._session, self._enable_kwargs_validation ) | ||
Comment on lines
+175
to
+187
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should not be needed. None of the other config kwargs receive this treatment and we should not start treating kwargs this way. What prompted this specific part of the PR? |
||
|
||
# Batch definitions | ||
self.batch = Batch() | ||
self.batch = Batch(self._enable_kwargs_validation ) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should not be needed. None of the other config kwargs receive this treatment and we should not start treating kwargs this way. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,16 +13,16 @@ | |
|
||
# Batch class | ||
class Batch: | ||
def __init__(self): | ||
def __init__(self, enable_kwarg_validation): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should not be needed. None of the other config kwargs receive this treatment and we should not start treating kwargs this way. |
||
# Action Batch helper API endpoints by section | ||
self.organizations = ActionBatchOrganizations() | ||
self.networks = ActionBatchNetworks() | ||
self.devices = ActionBatchDevices() | ||
self.appliance = ActionBatchAppliance() | ||
self.camera = ActionBatchCamera() | ||
self.cellularGateway = ActionBatchCellularGateway() | ||
self.insight = ActionBatchInsight() | ||
self.sensor = ActionBatchSensor() | ||
self.sm = ActionBatchSm() | ||
self.switch = ActionBatchSwitch() | ||
self.wireless = ActionBatchWireless() | ||
self.organizations = ActionBatchOrganizations(enable_kwarg_validation) | ||
self.networks = ActionBatchNetworks(enable_kwarg_validation) | ||
self.devices = ActionBatchDevices(enable_kwarg_validation) | ||
self.appliance = ActionBatchAppliance(enable_kwarg_validation) | ||
self.camera = ActionBatchCamera(enable_kwarg_validation) | ||
self.cellularGateway = ActionBatchCellularGateway(enable_kwarg_validation) | ||
self.insight = ActionBatchInsight(enable_kwarg_validation) | ||
self.sensor = ActionBatchSensor(enable_kwarg_validation) | ||
self.sm = ActionBatchSm(enable_kwarg_validation) | ||
self.switch = ActionBatchSwitch(enable_kwarg_validation) | ||
self.wireless = ActionBatchWireless(enable_kwarg_validation) | ||
Comment on lines
+18
to
+28
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should not be needed. None of the other config kwargs receive this treatment and we should not start treating kwargs this way. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -84,3 +84,6 @@ | |
# The choice is yours as long as you follow the format. You should **not** include other information in this string. | ||
# If you are an official ecosystem partner, this is required. | ||
MERAKI_PYTHON_SDK_CALLER = "" | ||
|
||
# Enable or disable kwargs validation | ||
ENABLE_KWARGS_VALIDATION = False | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is necessary. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes sense and is necessary.