Skip to content

[Python] Do not use mutable default argument#4613

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.

Sign up for GitHub

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

Closed
jirikuncar wants to merge 8 commits into from
Closed

[Python] Do not use mutable default argument #4613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bf7e33e
[Python] Do not use mutable default argument
jirikuncar Nov 26, 2019
0c3f787
[Python] Regenerated petstore project
jirikuncar Nov 26, 2019
c77ac13
[Python] Clean-up configuration template
jirikuncar Nov 27, 2019
027157f
[Python] Regenerated petstore projects
jirikuncar Nov 27, 2019
01c8647
[Python] remove default in server url
jirikuncar Nov 28, 2019
da67f9f
[Python] Regenerate openapi3 petstore client
jirikuncar Nov 29, 2019
de4e997
[Python] Remove docstrings from setters
jirikuncar Nov 29, 2019
e90ac04
[Python] Fix PEP8
jirikuncar Nov 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 30 additions & 53 deletions modules/openapi-generator/src/main/resources/python/configuration.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,14 +155,6 @@ class Configuration(object):

@logger_file.setter
def logger_file(self, value):
"""The logger file.

If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.

:param value: The logger_file path.
:type: str
"""
self.__logger_file = value
if self.__logger_file:
# If set logging file,
Expand All@@ -174,7 +166,7 @@ class Configuration(object):

@property
def debug(self):
"""Debug status

@spacetherspacetherNov 30, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a type description to this docstring
We are losing the information when we delete it from the setter

@jirikuncarjirikuncarDec 2, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spacether I don't get your comment.

@propertydefdebug(self):
"""The debug status. :param value: The debug status, True or False. :type: bool """

@spacetherspacetherDec 3, 2019•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my mistake, I missed the remaining bool type here. This is good.

"""The debug status.

:param value: The debug status, True or False.
:type: bool
Expand All@@ -183,11 +175,6 @@ class Configuration(object):

@debug.setter
def debug(self, value):
"""Debug status

:param value: The debug status, True or False.
:type: bool
"""
self.__debug = value
if self.__debug:
# if debug status is True, turn on debug logging
Expand DownExpand Up@@ -216,18 +203,11 @@ class Configuration(object):

@logger_format.setter
def logger_format(self, value):
"""The logger format.

The logger_formatter will be updated when sets logger_format.

:param value: The format string.
:type: str
"""
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)

def get_api_key_with_prefix(self, identifier):
"""Gets API key (with prefix if set).
"""Get API key (with prefix if set).

:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
Expand All@@ -243,7 +223,7 @@ class Configuration(object):
return key

def get_basic_auth_token(self):
"""Gets HTTP basic authentication header (string).
"""Get HTTP basic authentication header (string).

:return: The token for basic HTTP authentication.
"""
Expand All@@ -252,7 +232,7 @@ class Configuration(object):
).get('authorization')

def auth_settings(self):
"""Gets Auth Settings dict for api client.
"""Get Auth Settings dict for api client.

:return: The Auth Settings information dict.
"""
Expand DownExpand Up@@ -303,7 +283,7 @@ class Configuration(object):
}

def to_debug_report(self):
"""Gets the essential information for debugging.
"""Get the essential information for debugging.

:return: The report for debugging.
"""
Expand All@@ -315,7 +295,7 @@ class Configuration(object):
format(env=sys.platform, pyversion=sys.version)

def get_host_settings(self):
"""Gets an array of host settings
"""Get an array of host settings

:return: An array of host settings
"""
Expand DownExpand Up@@ -349,41 +329,38 @@ class Configuration(object):
{{/servers}}
]

def get_host_from_settings(self, index, variables={}):
"""Gets host URL based on the index and variables
def get_host_from_settings(self, index, variables=None):
"""Get host URL based on the index and variables.

:param index: array index of the host settings
:param variables: hash of variable and the corresponding value
:param variables: mapping of variable and the corresponding value
Comment thread
jirikuncar marked this conversation as resolved.
Outdated
:return: URL based on host settings
"""

variables = {} if variables is None else variables
Comment thread
jirikuncar marked this conversation as resolved.
Outdated
servers = self.get_host_settings()

# check array index out of bound
if index < 0 or index >= len(servers):
try:
server = servers[index]
Comment thread
jirikuncar marked this conversation as resolved.
Outdated
except IndexError:
raise ValueError(
"Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
.format(index, len(servers)))
"Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

server = servers[index]
url = server['url']

# go through variable and assign a value
for variable_name in server['variables']:
if variable_name in variables:
if variables[variable_name] in server['variables'][
variable_name]['enum_values']:
url = url.replace("{" + variable_name + "}",
variables[variable_name])
else:
raise ValueError(
"The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
.format(
variable_name, variables[variable_name],
server['variables'][variable_name]['enum_values']))
else:
# use default value
url = url.replace(
"{" + variable_name + "}",
server['variables'][variable_name]['default_value'])
# go through variables and replace placeholders
for variable_name, variable in server['variables'].items():
used_value = variables.get(
variable_name, variable['default_value'])

if 'enum_values' in variable \
and used_value not in variable['enum_values']:
raise ValueError(
"The variable `{0}` in the host URL has invalid value "
"{1}. Must be {2}.".format(
variable_name, variables[variable_name],
variable['enum_values']))

url = url.replace("{" + variable_name + "}", used_value)

return url
83 changes: 30 additions & 53 deletions samples/client/petstore/python-asyncio/petstore_api/configuration.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -140,14 +140,6 @@ def logger_file(self):

@logger_file.setter
def logger_file(self, value):
"""The logger file.

If the logger_file is None, then add stream handler and remove file
handler. Otherwise, add file handler and remove stream handler.

:param value: The logger_file path.
:type: str
"""
self.__logger_file = value
if self.__logger_file:
# If set logging file,
Expand All@@ -159,7 +151,7 @@ def logger_file(self, value):

@property
def debug(self):
"""Debug status
"""The debug status.

:param value: The debug status, True or False.
:type: bool
Expand All@@ -168,11 +160,6 @@ def debug(self):

@debug.setter
def debug(self, value):
"""Debug status

:param value: The debug status, True or False.
:type: bool
"""
self.__debug = value
if self.__debug:
# if debug status is True, turn on debug logging
Expand DownExpand Up@@ -201,18 +188,11 @@ def logger_format(self):

@logger_format.setter
def logger_format(self, value):
"""The logger format.

The logger_formatter will be updated when sets logger_format.

:param value: The format string.
:type: str
"""
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)

def get_api_key_with_prefix(self, identifier):
"""Gets API key (with prefix if set).
"""Get API key (with prefix if set).

:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
Expand All@@ -228,7 +208,7 @@ def get_api_key_with_prefix(self, identifier):
return key

def get_basic_auth_token(self):
"""Gets HTTP basic authentication header (string).
"""Get HTTP basic authentication header (string).

:return: The token for basic HTTP authentication.
"""
Expand All@@ -237,7 +217,7 @@ def get_basic_auth_token(self):
).get('authorization')

def auth_settings(self):
"""Gets Auth Settings dict for api client.
"""Get Auth Settings dict for api client.

:return: The Auth Settings information dict.
"""
Expand DownExpand Up@@ -273,7 +253,7 @@ def auth_settings(self):
}

def to_debug_report(self):
"""Gets the essential information for debugging.
"""Get the essential information for debugging.

:return: The report for debugging.
"""
Expand All@@ -285,7 +265,7 @@ def to_debug_report(self):
format(env=sys.platform, pyversion=sys.version)

def get_host_settings(self):
"""Gets an array of host settings
"""Get an array of host settings

:return: An array of host settings
"""
Expand All@@ -296,41 +276,38 @@ def get_host_settings(self):
}
]

def get_host_from_settings(self, index, variables={}):
"""Gets host URL based on the index and variables
def get_host_from_settings(self, index, variables=None):
"""Get host URL based on the index and variables.

:param index: array index of the host settings
:param variables: hash of variable and the corresponding value
:param variables: mapping of variable and the corresponding value
:return: URL based on host settings
"""

variables = {} if variables is None else variables
servers = self.get_host_settings()

# check array index out of bound
if index < 0 or index >= len(servers):
try:
server = servers[index]
except IndexError:
raise ValueError(
"Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
.format(index, len(servers)))
"Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

server = servers[index]
url = server['url']

# go through variable and assign a value
for variable_name in server['variables']:
if variable_name in variables:
if variables[variable_name] in server['variables'][
variable_name]['enum_values']:
url = url.replace("{" + variable_name + "}",
variables[variable_name])
else:
raise ValueError(
"The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
.format(
variable_name, variables[variable_name],
server['variables'][variable_name]['enum_values']))
else:
# use default value
url = url.replace(
"{" + variable_name + "}",
server['variables'][variable_name]['default_value'])
# go through variables and replace placeholders
for variable_name, variable in server['variables'].items():
used_value = variables.get(
variable_name, variable['default_value'])

if 'enum_values' in variable \
and used_value not in variable['enum_values']:
raise ValueError(
"The variable `{0}` in the host URL has invalid value "
"{1}. Must be {2}.".format(
variable_name, variables[variable_name],
variable['enum_values']))

url = url.replace("{" + variable_name + "}", used_value)

return url
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[Python] Do not use mutable default argument by jirikuncar · Pull Request #4613 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Python] Do not use mutable default argument#4613

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.

 Sign up for GitHub

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

 Closed

jirikuncar
wants to merge
8
commits into

from

 Closed


[Python] Do not use mutable default argument
#4613
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
bf7e33e

[Python] Do not use mutable default argument


jirikuncar Nov 26, 2019
0c3f787

[Python] Regenerated petstore project


jirikuncar Nov 26, 2019
c77ac13

[Python] Clean-up configuration template


jirikuncar Nov 27, 2019
027157f

[Python] Regenerated petstore projects


jirikuncar Nov 27, 2019
01c8647

[Python] remove default in server url


jirikuncar Nov 28, 2019
da67f9f

[Python] Regenerate openapi3 petstore client


jirikuncar Nov 29, 2019
de4e997

[Python] Remove docstrings from setters


jirikuncar Nov 29, 2019
e90ac04

[Python] Fix PEP8


jirikuncar Nov 29, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 30 additions & 53 deletions
modules/openapi-generator/src/main/resources/python/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,14 +155,6 @@ class Configuration(object):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -174,7 +166,7 @@ class Configuration(object):

 @property
 def debug(self):
 """Debug status
@spacetherspacetherNov 30, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a type description to this docstring

We are losing the information when we delete it from the setter
@jirikuncarjirikuncarDec 2, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spacether I don't get your comment.
@propertydefdebug(self):
"""The debug status. :param value: The debug status, True or False. :type: bool """
@spacetherspacetherDec 3, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my mistake, I missed the remaining bool type here. This is good.
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -183,11 +175,6 @@ class Configuration(object):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -216,18 +203,11 @@ class Configuration(object):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -243,7 +223,7 @@ class Configuration(object):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -252,7 +232,7 @@ class Configuration(object):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -303,7 +283,7 @@ class Configuration(object):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -315,7 +295,7 @@ class Configuration(object):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand DownExpand Up@@ -349,41 +329,38 @@ class Configuration(object):
 {{/servers}}
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url

83 changes: 30 additions & 53 deletions
samples/client/petstore/python-asyncio/petstore_api/configuration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,14 +140,6 @@ def logger_file(self):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -159,7 +151,7 @@ def logger_file(self, value):

 @property
 def debug(self):
 """Debug status
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -168,11 +160,6 @@ def debug(self):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -201,18 +188,11 @@ def logger_format(self):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -228,7 +208,7 @@ def get_api_key_with_prefix(self, identifier):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -237,7 +217,7 @@ def get_basic_auth_token(self):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -273,7 +253,7 @@ def auth_settings(self):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -285,7 +265,7 @@ def to_debug_report(self):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand All@@ -296,41 +276,38 @@ def get_host_settings(self):
 }
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Python] Do not use mutable default argument by jirikuncar · Pull Request #4613 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Python] Do not use mutable default argument#4613

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.

 Sign up for GitHub

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

 Closed

jirikuncar
wants to merge
8
commits into

from

 Closed


[Python] Do not use mutable default argument
#4613
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
bf7e33e

[Python] Do not use mutable default argument


jirikuncar Nov 26, 2019
0c3f787

[Python] Regenerated petstore project


jirikuncar Nov 26, 2019
c77ac13

[Python] Clean-up configuration template


jirikuncar Nov 27, 2019
027157f

[Python] Regenerated petstore projects


jirikuncar Nov 27, 2019
01c8647

[Python] remove default in server url


jirikuncar Nov 28, 2019
da67f9f

[Python] Regenerate openapi3 petstore client


jirikuncar Nov 29, 2019
de4e997

[Python] Remove docstrings from setters


jirikuncar Nov 29, 2019
e90ac04

[Python] Fix PEP8


jirikuncar Nov 29, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 30 additions & 53 deletions
modules/openapi-generator/src/main/resources/python/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,14 +155,6 @@ class Configuration(object):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -174,7 +166,7 @@ class Configuration(object):

 @property
 def debug(self):
 """Debug status
@spacetherspacetherNov 30, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a type description to this docstring

We are losing the information when we delete it from the setter
@jirikuncarjirikuncarDec 2, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spacether I don't get your comment.
@propertydefdebug(self):
"""The debug status. :param value: The debug status, True or False. :type: bool """
@spacetherspacetherDec 3, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my mistake, I missed the remaining bool type here. This is good.
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -183,11 +175,6 @@ class Configuration(object):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -216,18 +203,11 @@ class Configuration(object):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -243,7 +223,7 @@ class Configuration(object):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -252,7 +232,7 @@ class Configuration(object):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -303,7 +283,7 @@ class Configuration(object):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -315,7 +295,7 @@ class Configuration(object):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand DownExpand Up@@ -349,41 +329,38 @@ class Configuration(object):
 {{/servers}}
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url

83 changes: 30 additions & 53 deletions
samples/client/petstore/python-asyncio/petstore_api/configuration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,14 +140,6 @@ def logger_file(self):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -159,7 +151,7 @@ def logger_file(self, value):

 @property
 def debug(self):
 """Debug status
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -168,11 +160,6 @@ def debug(self):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -201,18 +188,11 @@ def logger_format(self):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -228,7 +208,7 @@ def get_api_key_with_prefix(self, identifier):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -237,7 +217,7 @@ def get_basic_auth_token(self):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -273,7 +253,7 @@ def auth_settings(self):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -285,7 +265,7 @@ def to_debug_report(self):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand All@@ -296,41 +276,38 @@ def get_host_settings(self):
 }
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Python] Do not use mutable default argument by jirikuncar · Pull Request #4613 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Python] Do not use mutable default argument#4613

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.

 Sign up for GitHub

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

 Closed

jirikuncar
wants to merge
8
commits into

from

 Closed


[Python] Do not use mutable default argument
#4613
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
bf7e33e

[Python] Do not use mutable default argument


jirikuncar Nov 26, 2019
0c3f787

[Python] Regenerated petstore project


jirikuncar Nov 26, 2019
c77ac13

[Python] Clean-up configuration template


jirikuncar Nov 27, 2019
027157f

[Python] Regenerated petstore projects


jirikuncar Nov 27, 2019
01c8647

[Python] remove default in server url


jirikuncar Nov 28, 2019
da67f9f

[Python] Regenerate openapi3 petstore client


jirikuncar Nov 29, 2019
de4e997

[Python] Remove docstrings from setters


jirikuncar Nov 29, 2019
e90ac04

[Python] Fix PEP8


jirikuncar Nov 29, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 30 additions & 53 deletions
modules/openapi-generator/src/main/resources/python/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,14 +155,6 @@ class Configuration(object):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -174,7 +166,7 @@ class Configuration(object):

 @property
 def debug(self):
 """Debug status
@spacetherspacetherNov 30, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a type description to this docstring

We are losing the information when we delete it from the setter
@jirikuncarjirikuncarDec 2, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spacether I don't get your comment.
@propertydefdebug(self):
"""The debug status. :param value: The debug status, True or False. :type: bool """
@spacetherspacetherDec 3, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my mistake, I missed the remaining bool type here. This is good.
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -183,11 +175,6 @@ class Configuration(object):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -216,18 +203,11 @@ class Configuration(object):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -243,7 +223,7 @@ class Configuration(object):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -252,7 +232,7 @@ class Configuration(object):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -303,7 +283,7 @@ class Configuration(object):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -315,7 +295,7 @@ class Configuration(object):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand DownExpand Up@@ -349,41 +329,38 @@ class Configuration(object):
 {{/servers}}
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url

83 changes: 30 additions & 53 deletions
samples/client/petstore/python-asyncio/petstore_api/configuration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,14 +140,6 @@ def logger_file(self):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -159,7 +151,7 @@ def logger_file(self, value):

 @property
 def debug(self):
 """Debug status
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -168,11 +160,6 @@ def debug(self):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -201,18 +188,11 @@ def logger_format(self):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -228,7 +208,7 @@ def get_api_key_with_prefix(self, identifier):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -237,7 +217,7 @@ def get_basic_auth_token(self):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -273,7 +253,7 @@ def auth_settings(self):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -285,7 +265,7 @@ def to_debug_report(self):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand All@@ -296,41 +276,38 @@ def get_host_settings(self):
 }
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[Python] Do not use mutable default argument by jirikuncar · Pull Request #4613 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Python] Do not use mutable default argument#4613

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.

 Sign up for GitHub

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

 Closed

jirikuncar
wants to merge
8
commits into

from

 Closed


[Python] Do not use mutable default argument
#4613
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
bf7e33e

[Python] Do not use mutable default argument


jirikuncar Nov 26, 2019
0c3f787

[Python] Regenerated petstore project


jirikuncar Nov 26, 2019
c77ac13

[Python] Clean-up configuration template


jirikuncar Nov 27, 2019
027157f

[Python] Regenerated petstore projects


jirikuncar Nov 27, 2019
01c8647

[Python] remove default in server url


jirikuncar Nov 28, 2019
da67f9f

[Python] Regenerate openapi3 petstore client


jirikuncar Nov 29, 2019
de4e997

[Python] Remove docstrings from setters


jirikuncar Nov 29, 2019
e90ac04

[Python] Fix PEP8


jirikuncar Nov 29, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 30 additions & 53 deletions
modules/openapi-generator/src/main/resources/python/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,14 +155,6 @@ class Configuration(object):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -174,7 +166,7 @@ class Configuration(object):

 @property
 def debug(self):
 """Debug status
@spacetherspacetherNov 30, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a type description to this docstring

We are losing the information when we delete it from the setter
@jirikuncarjirikuncarDec 2, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spacether I don't get your comment.
@propertydefdebug(self):
"""The debug status. :param value: The debug status, True or False. :type: bool """
@spacetherspacetherDec 3, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my mistake, I missed the remaining bool type here. This is good.
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -183,11 +175,6 @@ class Configuration(object):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -216,18 +203,11 @@ class Configuration(object):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -243,7 +223,7 @@ class Configuration(object):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -252,7 +232,7 @@ class Configuration(object):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -303,7 +283,7 @@ class Configuration(object):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -315,7 +295,7 @@ class Configuration(object):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand DownExpand Up@@ -349,41 +329,38 @@ class Configuration(object):
 {{/servers}}
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url

83 changes: 30 additions & 53 deletions
samples/client/petstore/python-asyncio/petstore_api/configuration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,14 +140,6 @@ def logger_file(self):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -159,7 +151,7 @@ def logger_file(self, value):

 @property
 def debug(self):
 """Debug status
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -168,11 +160,6 @@ def debug(self):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -201,18 +188,11 @@ def logger_format(self):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -228,7 +208,7 @@ def get_api_key_with_prefix(self, identifier):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -237,7 +217,7 @@ def get_basic_auth_token(self):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -273,7 +253,7 @@ def auth_settings(self):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -285,7 +265,7 @@ def to_debug_report(self):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand All@@ -296,41 +276,38 @@ def get_host_settings(self):
 }
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Python] Do not use mutable default argument by jirikuncar · Pull Request #4613 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Python] Do not use mutable default argument#4613

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.

 Sign up for GitHub

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

 Closed

jirikuncar
wants to merge
8
commits into

from

 Closed


[Python] Do not use mutable default argument
#4613
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
bf7e33e

[Python] Do not use mutable default argument


jirikuncar Nov 26, 2019
0c3f787

[Python] Regenerated petstore project


jirikuncar Nov 26, 2019
c77ac13

[Python] Clean-up configuration template


jirikuncar Nov 27, 2019
027157f

[Python] Regenerated petstore projects


jirikuncar Nov 27, 2019
01c8647

[Python] remove default in server url


jirikuncar Nov 28, 2019
da67f9f

[Python] Regenerate openapi3 petstore client


jirikuncar Nov 29, 2019
de4e997

[Python] Remove docstrings from setters


jirikuncar Nov 29, 2019
e90ac04

[Python] Fix PEP8


jirikuncar Nov 29, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 30 additions & 53 deletions
modules/openapi-generator/src/main/resources/python/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,14 +155,6 @@ class Configuration(object):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -174,7 +166,7 @@ class Configuration(object):

 @property
 def debug(self):
 """Debug status
@spacetherspacetherNov 30, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a type description to this docstring

We are losing the information when we delete it from the setter
@jirikuncarjirikuncarDec 2, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spacether I don't get your comment.
@propertydefdebug(self):
"""The debug status. :param value: The debug status, True or False. :type: bool """
@spacetherspacetherDec 3, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my mistake, I missed the remaining bool type here. This is good.
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -183,11 +175,6 @@ class Configuration(object):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -216,18 +203,11 @@ class Configuration(object):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -243,7 +223,7 @@ class Configuration(object):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -252,7 +232,7 @@ class Configuration(object):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -303,7 +283,7 @@ class Configuration(object):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -315,7 +295,7 @@ class Configuration(object):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand DownExpand Up@@ -349,41 +329,38 @@ class Configuration(object):
 {{/servers}}
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url

83 changes: 30 additions & 53 deletions
samples/client/petstore/python-asyncio/petstore_api/configuration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,14 +140,6 @@ def logger_file(self):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -159,7 +151,7 @@ def logger_file(self, value):

 @property
 def debug(self):
 """Debug status
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -168,11 +160,6 @@ def debug(self):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -201,18 +188,11 @@ def logger_format(self):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -228,7 +208,7 @@ def get_api_key_with_prefix(self, identifier):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -237,7 +217,7 @@ def get_basic_auth_token(self):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -273,7 +253,7 @@ def auth_settings(self):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -285,7 +265,7 @@ def to_debug_report(self):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand All@@ -296,41 +276,38 @@ def get_host_settings(self):
 }
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Python] Do not use mutable default argument by jirikuncar · Pull Request #4613 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Python] Do not use mutable default argument#4613

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.

 Sign up for GitHub

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

 Closed

jirikuncar
wants to merge
8
commits into

from

 Closed


[Python] Do not use mutable default argument
#4613
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
bf7e33e

[Python] Do not use mutable default argument


jirikuncar Nov 26, 2019
0c3f787

[Python] Regenerated petstore project


jirikuncar Nov 26, 2019
c77ac13

[Python] Clean-up configuration template


jirikuncar Nov 27, 2019
027157f

[Python] Regenerated petstore projects


jirikuncar Nov 27, 2019
01c8647

[Python] remove default in server url


jirikuncar Nov 28, 2019
da67f9f

[Python] Regenerate openapi3 petstore client


jirikuncar Nov 29, 2019
de4e997

[Python] Remove docstrings from setters


jirikuncar Nov 29, 2019
e90ac04

[Python] Fix PEP8


jirikuncar Nov 29, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 30 additions & 53 deletions
modules/openapi-generator/src/main/resources/python/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,14 +155,6 @@ class Configuration(object):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -174,7 +166,7 @@ class Configuration(object):

 @property
 def debug(self):
 """Debug status
@spacetherspacetherNov 30, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a type description to this docstring

We are losing the information when we delete it from the setter
@jirikuncarjirikuncarDec 2, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spacether I don't get your comment.
@propertydefdebug(self):
"""The debug status. :param value: The debug status, True or False. :type: bool """
@spacetherspacetherDec 3, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my mistake, I missed the remaining bool type here. This is good.
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -183,11 +175,6 @@ class Configuration(object):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -216,18 +203,11 @@ class Configuration(object):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -243,7 +223,7 @@ class Configuration(object):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -252,7 +232,7 @@ class Configuration(object):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -303,7 +283,7 @@ class Configuration(object):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -315,7 +295,7 @@ class Configuration(object):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand DownExpand Up@@ -349,41 +329,38 @@ class Configuration(object):
 {{/servers}}
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url

83 changes: 30 additions & 53 deletions
samples/client/petstore/python-asyncio/petstore_api/configuration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,14 +140,6 @@ def logger_file(self):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -159,7 +151,7 @@ def logger_file(self, value):

 @property
 def debug(self):
 """Debug status
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -168,11 +160,6 @@ def debug(self):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -201,18 +188,11 @@ def logger_format(self):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -228,7 +208,7 @@ def get_api_key_with_prefix(self, identifier):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -237,7 +217,7 @@ def get_basic_auth_token(self):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -273,7 +253,7 @@ def auth_settings(self):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -285,7 +265,7 @@ def to_debug_report(self):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand All@@ -296,41 +276,38 @@ def get_host_settings(self):
 }
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[Python] Do not use mutable default argument by jirikuncar · Pull Request #4613 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Python] Do not use mutable default argument#4613

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.

 Sign up for GitHub

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

 Closed

jirikuncar
wants to merge
8
commits into

from

 Closed


[Python] Do not use mutable default argument
#4613
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
bf7e33e

[Python] Do not use mutable default argument


jirikuncar Nov 26, 2019
0c3f787

[Python] Regenerated petstore project


jirikuncar Nov 26, 2019
c77ac13

[Python] Clean-up configuration template


jirikuncar Nov 27, 2019
027157f

[Python] Regenerated petstore projects


jirikuncar Nov 27, 2019
01c8647

[Python] remove default in server url


jirikuncar Nov 28, 2019
da67f9f

[Python] Regenerate openapi3 petstore client


jirikuncar Nov 29, 2019
de4e997

[Python] Remove docstrings from setters


jirikuncar Nov 29, 2019
e90ac04

[Python] Fix PEP8


jirikuncar Nov 29, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


83 changes: 30 additions & 53 deletions
modules/openapi-generator/src/main/resources/python/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -155,14 +155,6 @@ class Configuration(object):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -174,7 +166,7 @@ class Configuration(object):

 @property
 def debug(self):
 """Debug status
@spacetherspacetherNov 30, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a type description to this docstring

We are losing the information when we delete it from the setter
@jirikuncarjirikuncarDec 2, 2019

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@spacether I don't get your comment.
@propertydefdebug(self):
"""The debug status. :param value: The debug status, True or False. :type: bool """
@spacetherspacetherDec 3, 2019•

edited

Loading

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my mistake, I missed the remaining bool type here. This is good.
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -183,11 +175,6 @@ class Configuration(object):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -216,18 +203,11 @@ class Configuration(object):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -243,7 +223,7 @@ class Configuration(object):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -252,7 +232,7 @@ class Configuration(object):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -303,7 +283,7 @@ class Configuration(object):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -315,7 +295,7 @@ class Configuration(object):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand DownExpand Up@@ -349,41 +329,38 @@ class Configuration(object):
 {{/servers}}
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
Comment thread
jirikuncar marked this conversation as resolved.


Outdated

 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url

83 changes: 30 additions & 53 deletions
samples/client/petstore/python-asyncio/petstore_api/configuration.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -140,14 +140,6 @@ def logger_file(self):

 @logger_file.setter
 def logger_file(self, value):
 """The logger file.

 If the logger_file is None, then add stream handler and remove file
 handler. Otherwise, add file handler and remove stream handler.

 :param value: The logger_file path.
 :type: str
 """
 self.__logger_file = value
 if self.__logger_file:
 # If set logging file,
Expand All@@ -159,7 +151,7 @@ def logger_file(self, value):

 @property
 def debug(self):
 """Debug status
 """The debug status.

 :param value: The debug status, True or False.
 :type: bool
Expand All@@ -168,11 +160,6 @@ def debug(self):

 @debug.setter
 def debug(self, value):
 """Debug status

 :param value: The debug status, True or False.
 :type: bool
 """
 self.__debug = value
 if self.__debug:
 # if debug status is True, turn on debug logging
Expand DownExpand Up@@ -201,18 +188,11 @@ def logger_format(self):

 @logger_format.setter
 def logger_format(self, value):
 """The logger format.

 The logger_formatter will be updated when sets logger_format.

 :param value: The format string.
 :type: str
 """
 self.__logger_format = value
 self.logger_formatter = logging.Formatter(self.__logger_format)

 def get_api_key_with_prefix(self, identifier):
 """Gets API key (with prefix if set).
 """Get API key (with prefix if set).

 :param identifier: The identifier of apiKey.
 :return: The token for api key authentication.
Expand All@@ -228,7 +208,7 @@ def get_api_key_with_prefix(self, identifier):
 return key

 def get_basic_auth_token(self):
 """Gets HTTP basic authentication header (string).
 """Get HTTP basic authentication header (string).

 :return: The token for basic HTTP authentication.
 """
Expand All@@ -237,7 +217,7 @@ def get_basic_auth_token(self):
 ).get('authorization')

 def auth_settings(self):
 """Gets Auth Settings dict for api client.
 """Get Auth Settings dict for api client.

 :return: The Auth Settings information dict.
 """
Expand DownExpand Up@@ -273,7 +253,7 @@ def auth_settings(self):
 }

 def to_debug_report(self):
 """Gets the essential information for debugging.
 """Get the essential information for debugging.

 :return: The report for debugging.
 """
Expand All@@ -285,7 +265,7 @@ def to_debug_report(self):
 format(env=sys.platform, pyversion=sys.version)

 def get_host_settings(self):
 """Gets an array of host settings
 """Get an array of host settings

 :return: An array of host settings
 """
Expand All@@ -296,41 +276,38 @@ def get_host_settings(self):
 }
 ]

 def get_host_from_settings(self, index, variables={}):
 """Gets host URL based on the index and variables
 def get_host_from_settings(self, index, variables=None):
 """Get host URL based on the index and variables.

 :param index: array index of the host settings
 :param variables: hash of variable and the corresponding value
 :param variables: mapping of variable and the corresponding value
 :return: URL based on host settings
 """

 variables = {} if variables is None else variables
 servers = self.get_host_settings()

 # check array index out of bound
 if index < 0 or index >= len(servers):
 try:
 server = servers[index]
 except IndexError:
 raise ValueError(
 "Invalid index {} when selecting the host settings. Must be less than {}" # noqa: E501
 .format(index, len(servers)))
 "Invalid index {0} when selecting the host settings. "
"Must be less than {1}".format(index, len(servers)))

 server = servers[index]
 url = server['url']

 # go through variable and assign a value
 for variable_name in server['variables']:
 if variable_name in variables:
 if variables[variable_name] in server['variables'][
 variable_name]['enum_values']:
 url = url.replace("{" + variable_name + "}",
 variables[variable_name])
 else:
 raise ValueError(
 "The variable `{}` in the host URL has invalid value {}. Must be {}." # noqa: E501
 .format(
 variable_name, variables[variable_name],
 server['variables'][variable_name]['enum_values']))
 else:
 # use default value
 url = url.replace(
 "{" + variable_name + "}",
 server['variables'][variable_name]['default_value'])
 # go through variables and replace placeholders
 for variable_name, variable in server['variables'].items():
 used_value = variables.get(
 variable_name, variable['default_value'])

 if 'enum_values' in variable \
 and used_value not in variable['enum_values']:
 raise ValueError(
 "The variable `{0}` in the host URL has invalid value "
 "{1}. Must be {2}.".format(
 variable_name, variables[variable_name],
 variable['enum_values']))

 url = url.replace("{" + variable_name + "}", used_value)

 return url
Loading