Skip to content

SG-12945: Added localized param to Shotgun object #204

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
palisir wants to merge 10 commits into from
Closed

SG-12945: Added localized param to Shotgun object #204

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
117e190
SG-12945: Added localized param to Shotgun object
Jul 29, 2019
0b3f1c4
Adding the following method to the documentation (#206)
victoriagrey Aug 22, 2019
267b811
SG-13608 Revert mimetypes module (#207)
willis102 Aug 29, 2019
d27fb2e
Packaging up for the 3.1.1 release.
willis102 Aug 29, 2019
e8d7f60
SG-12945: Added localized param to Shotgun object
Jul 29, 2019
03f2d6f
set default localization param to False
palisir Aug 1, 2019
239dfd6
added test for locale header
palisir Sep 2, 2019
5d532cd
merge 239dfd64bba4ed8cb5ae81ed38fd59af6f83c9aa with remote
palisir Sep 3, 2019
922bae7
added instruction for good syntax on example config file
palisir Sep 3, 2019
5f22ce5
removed localized param from constructor and added test for localized…
palisir Sep 3, 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
12 changes: 11 additions & 1 deletion shotgun_api3/shotgun.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,6 +427,7 @@ def __init__(self, sg):
self.session_token = None
self.authorization = None
self.no_ssl_validation = False
self.localized = True

@property
def records_per_page(self):
Expand Down Expand Up @@ -469,7 +470,8 @@ def __init__(self,
password=None,
sudo_as_login=None,
session_token=None,
auth_token=None):
auth_token=None,
localized=True):
Copy link
Copy Markdown
Contributor

@thebeeland thebeeland Aug 1, 2019

Choose a reason for hiding this comment

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

I might default this to False. My fear would be that this will change the form of the data returned by the API and might break existing client scripts (or even stuff in Toolkit that we provide) without additional code changes to compensate for it.

"""
Initializes a new instance of the Shotgun client.

Expand Down Expand Up @@ -538,6 +540,9 @@ def __init__(self,
``auth_token`` is invalid.
.. todo: Add this info to the Authentication section of the docs

:param bool localized: A boolean to asks for some fields to be localized. When ``True``, a
Copy link
Copy Markdown
Contributor

@manneohrstrom manneohrstrom Sep 4, 2019

Choose a reason for hiding this comment

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

This does not match the parameters of the constructor.

header ``locale`` with value ``auto`` is added to HTTP requests. Default is ``True``.

.. note:: A note about proxy connections: If you are using Python <= v2.6.2, HTTPS
connections through a proxy server will not work due to a bug in the :mod:`urllib2`
library (see http://bugs.python.org/issue1424152). This will affect upload and
Expand Down Expand Up @@ -598,6 +603,7 @@ def __init__(self,
self.config.convert_datetimes_to_utc = convert_datetimes_to_utc
self.config.no_ssl_validation = NO_SSL_VALIDATION
self.config.raw_http_proxy = http_proxy
self.config.localized = localized

try:
self.config.rpc_attempt_interval = int(os.environ.get("SHOTGUN_API_RETRY_INTERVAL", 3000))
Expand Down Expand Up @@ -3205,6 +3211,10 @@ def _call_rpc(self, method, params, include_auth_params=True, first=False):
"content-type": "application/json; charset=utf-8",
"connection": "keep-alive"
}

if self.config.localized is True:
req_headers["locale"] = "auto"

http_status, resp_headers, body = self._make_call("POST", self.config.api_path,
encoded_payload, req_headers)
LOG.debug("Completed rpc call to %s" % (method))
Expand Down