Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

fix: use the [] after key names for array variables inparams#1699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
nejch merged 1 commit intomainfromjlvillal/arrays
Jul 27, 2022
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
15 changes: 12 additions & 3 deletionsgitlab/mixins.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -238,7 +238,12 @@ def list(self, **kwargs: Any) -> Union[base.RESTObjectList, List[base.RESTObject
GitlabListError: If the server cannot perform the request
"""

data, _ = utils._transform_types(kwargs, self._types, transform_files=False)
data, _ = utils._transform_types(
data=kwargs,
custom_types=self._types,
transform_data=True,
transform_files=False,
)

if self.gitlab.per_page:
data.setdefault("per_page", self.gitlab.per_page)
Expand DownExpand Up@@ -303,7 +308,9 @@ def create(
data = {}

self._create_attrs.validate_attrs(data=data)
data, files = utils._transform_types(data, self._types)
data, files = utils._transform_types(
data=data, custom_types=self._types, transform_data=False
)

# Handle specific URL for creation
path = kwargs.pop("path", self.path)
Expand DownExpand Up@@ -370,7 +377,9 @@ def update(
if self._obj_cls is not None and self._obj_cls._id_attr is not None:
excludes = [self._obj_cls._id_attr]
self._update_attrs.validate_attrs(data=new_data, excludes=excludes)
new_data, files = utils._transform_types(new_data, self._types)
new_data, files = utils._transform_types(
data=new_data, custom_types=self._types, transform_data=False
)

http_method = self._get_update_method()
result = http_method(path, post_data=new_data, files=files, **kwargs)
Expand Down
22 changes: 15 additions & 7 deletionsgitlab/types.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,8 +63,8 @@ def get(self) -> Any:
def set_from_cli(self, cli_value: Any) -> None:
self._value = cli_value

def get_for_api(self) -> Any:
return self._value
def get_for_api(self, *, key: str) ->Tuple[str,Any]:
return(key,self._value)


class _ListArrayAttribute(GitlabAttribute):
Expand All@@ -76,20 +76,28 @@ def set_from_cli(self, cli_value: str) -> None:
else:
self._value = [item.strip() for item in cli_value.split(",")]

def get_for_api(self) -> str:
def get_for_api(self, *, key: str) ->Tuple[str, str]:
# Do not comma-split single value passed as string
if isinstance(self._value, str):
return self._value
return(key,self._value)

if TYPE_CHECKING:
assert isinstance(self._value, list)
return ",".join([str(x) for x in self._value])
return(key,",".join([str(x) for x in self._value]))


class ArrayAttribute(_ListArrayAttribute):
"""To support `array` types as documented in
https://docs.gitlab.com/ee/api/#array"""

def get_for_api(self, *, key: str) -> Tuple[str, Any]:
if isinstance(self._value, str):
return (f"{key}[]", self._value)

if TYPE_CHECKING:
assert isinstance(self._value, list)
return (f"{key}[]", self._value)


class CommaSeparatedListAttribute(_ListArrayAttribute):
"""For values which are sent to the server as a Comma Separated Values
Expand All@@ -98,8 +106,8 @@ class CommaSeparatedListAttribute(_ListArrayAttribute):


class LowercaseStringAttribute(GitlabAttribute):
def get_for_api(self) -> str:
return str(self._value).lower()
def get_for_api(self, *, key: str) ->Tuple[str, str]:
return(key,str(self._value).lower())


class FileAttribute(GitlabAttribute):
Expand Down
39 changes: 30 additions & 9 deletionsgitlab/utils.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,34 +55,53 @@ def response_content(


def _transform_types(
data: Dict[str, Any], custom_types: dict, *, transform_files: Optional[bool] = True
data: Dict[str, Any],
custom_types: dict,
*,
transform_data: bool,
transform_files: Optional[bool] = True,
) -> Tuple[dict, dict]:
"""Copy the data dict with attributes that have custom types and transform them
before being sent to the server.

If``transform_files`` is ``True`` (default), also populates the ``files`` dict for
``transform_files``: If ``True`` (default), also populates the ``files`` dict for
FileAttribute types with tuples to prepare fields for requests' MultipartEncoder:
https://toolbelt.readthedocs.io/en/latest/user.html#multipart-form-data-encoder

``transform_data``: If ``True`` transforms the ``data`` dict with fields
suitable for encoding as query parameters for GitLab's API:
https://docs.gitlab.com/ee/api/#encoding-api-parameters-of-array-and-hash-types

Returns:
A tuple of the transformed data dict and files dict"""

# Duplicate data to avoid messing with what the user sent us
data = data.copy()
if not transform_files and not transform_data:
return data, {}

files = {}

for attr_name,type_cls in custom_types.items():
for attr_name,attr_class in custom_types.items():
if attr_name not in data:
continue

type_obj =type_cls(data[attr_name])
gitlab_attribute =attr_class(data[attr_name])

# if the typeif FileAttribute we need to pass the data as file
iftransform_files andisinstance(type_obj, types.FileAttribute):
key =type_obj.get_file_name(attr_name)
# if the typeis FileAttribute we need to pass the data as file
if isinstance(gitlab_attribute, types.FileAttribute) and transform_files:
key =gitlab_attribute.get_file_name(attr_name)
files[attr_name] = (key, data.pop(attr_name))
else:
data[attr_name] = type_obj.get_for_api()
continue

if not transform_data:
continue

if isinstance(gitlab_attribute, types.GitlabAttribute):
key, value = gitlab_attribute.get_for_api(key=attr_name)
if key != attr_name:
del data[attr_name]
data[key] = value

return data, files

Expand All@@ -94,6 +113,8 @@ def copy_dict(
) -> None:
for k, v in src.items():
if isinstance(v, dict):
# NOTE(jlvillal): This provides some support for the `hash` type
# https://docs.gitlab.com/ee/api/#hash
# Transform dict values to new attributes. For example:
# custom_attributes: {'foo', 'bar'} =>
# "custom_attributes['foo']": "bar"
Expand Down
5 changes: 5 additions & 0 deletionstests/functional/api/test_groups.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,6 +99,11 @@ def test_groups(gl):
assert len(group1.members.list()) == 3
assert len(group2.members.list()) == 2

# Test `user_ids` array
result = group1.members.list(user_ids=[user.id, 99999])
assert len(result) == 1
assert result[0].id == user.id

group1.members.delete(user.id)
assert user not in group1.members.list()
assert group1.members_all.list()
Expand Down
38 changes: 38 additions & 0 deletionstests/unit/mixins/test_mixin_methods.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,25 @@ class M(ListMixin, FakeManager):
assert responses.assert_call_count(url, 2) is True


@responses.activate
def test_list_mixin_with_attributes(gl):
class M(ListMixin, FakeManager):
_types = {"my_array": gl_types.ArrayAttribute}

url = "http://localhost/api/v4/tests"
responses.add(
method=responses.GET,
headers={},
url=url,
json=[],
status=200,
match=[responses.matchers.query_param_matcher({"my_array[]": ["1", "2", "3"]})],
)

mgr = M(gl)
mgr.list(iterator=True, my_array=[1, 2, 3])


@responses.activate
def test_list_other_url(gl):
class M(ListMixin, FakeManager):
Expand DownExpand Up@@ -295,6 +314,25 @@ class M(CreateMixin, FakeManager):
assert responses.assert_call_count(url, 1) is True


@responses.activate
def test_create_mixin_with_attributes(gl):
class M(CreateMixin, FakeManager):
_types = {"my_array": gl_types.ArrayAttribute}

url = "http://localhost/api/v4/tests"
responses.add(
method=responses.POST,
headers={},
url=url,
json={},
status=200,
match=[responses.matchers.json_params_matcher({"my_array": [1, 2, 3]})],
)

mgr = M(gl)
mgr.create({"my_array": [1, 2, 3]})


def test_update_mixin_missing_attrs(gl):
class M(UpdateMixin, FakeManager):
_update_attrs = gl_types.RequiredOptional(
Expand Down
18 changes: 9 additions & 9 deletionstests/unit/test_types.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,7 +73,7 @@ def test_gitlab_attribute_get():

o.set_from_cli("whatever2")
assert o.get() == "whatever2"
assert o.get_for_api() =="whatever2"
assert o.get_for_api(key="spam") ==("spam", "whatever2")

o = types.GitlabAttribute()
assert o._value is None
Expand All@@ -100,42 +100,42 @@ def test_array_attribute_empty_input():
def test_array_attribute_get_for_api_from_cli():
o = types.ArrayAttribute()
o.set_from_cli("foo,bar,baz")
assert o.get_for_api() =="foo,bar,baz"
assert o.get_for_api(key="spam") ==("spam[]", ["foo", "bar", "baz"])


def test_array_attribute_get_for_api_from_list():
o = types.ArrayAttribute(["foo", "bar", "baz"])
assert o.get_for_api() =="foo,bar,baz"
assert o.get_for_api(key="spam") ==("spam[]", ["foo", "bar", "baz"])


def test_array_attribute_get_for_api_from_int_list():
o = types.ArrayAttribute([1, 9, 7])
assert o.get_for_api() =="1,9,7"
assert o.get_for_api(key="spam") ==("spam[]", [1, 9, 7])


def test_array_attribute_does_not_split_string():
o = types.ArrayAttribute("foo")
assert o.get_for_api() =="foo"
assert o.get_for_api(key="spam") ==("spam[]", "foo")


# CommaSeparatedListAttribute tests
def test_csv_string_attribute_get_for_api_from_cli():
o = types.CommaSeparatedListAttribute()
o.set_from_cli("foo,bar,baz")
assert o.get_for_api() =="foo,bar,baz"
assert o.get_for_api(key="spam") ==("spam", "foo,bar,baz")


def test_csv_string_attribute_get_for_api_from_list():
o = types.CommaSeparatedListAttribute(["foo", "bar", "baz"])
assert o.get_for_api() =="foo,bar,baz"
assert o.get_for_api(key="spam") ==("spam", "foo,bar,baz")


def test_csv_string_attribute_get_for_api_from_int_list():
o = types.CommaSeparatedListAttribute([1, 9, 7])
assert o.get_for_api() =="1,9,7"
assert o.get_for_api(key="spam") ==("spam", "1,9,7")


# LowercaseStringAttribute tests
def test_lowercase_string_attribute_get_for_api():
o = types.LowercaseStringAttribute("FOO")
assert o.get_for_api() =="foo"
assert o.get_for_api(key="spam") ==("spam", "foo")
28 changes: 25 additions & 3 deletionstests/unit/test_utils.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -155,7 +155,7 @@ def test_remove_none_from_dict(dictionary, expected):

def test_transform_types_copies_data_with_empty_files():
data = {"attr": "spam"}
new_data, files = utils._transform_types(data, {})
new_data, files = utils._transform_types(data, {}, transform_data=True)

assert new_data is not data
assert new_data == data
Expand All@@ -165,7 +165,7 @@ def test_transform_types_copies_data_with_empty_files():
def test_transform_types_with_transform_files_populates_files():
custom_types = {"attr": types.FileAttribute}
data = {"attr": "spam"}
new_data, files = utils._transform_types(data, custom_types)
new_data, files = utils._transform_types(data, custom_types, transform_data=True)

assert new_data == {}
assert files["attr"] == ("attr", "spam")
Expand All@@ -174,7 +174,29 @@ def test_transform_types_with_transform_files_populates_files():
def test_transform_types_without_transform_files_populates_data_with_empty_files():
custom_types = {"attr": types.FileAttribute}
data = {"attr": "spam"}
new_data, files = utils._transform_types(data, custom_types, transform_files=False)
new_data, files = utils._transform_types(
data, custom_types, transform_files=False, transform_data=True
)

assert new_data == {"attr": "spam"}
assert files == {}


def test_transform_types_params_array():
data = {"attr": [1, 2, 3]}
custom_types = {"attr": types.ArrayAttribute}
new_data, files = utils._transform_types(data, custom_types, transform_data=True)

assert new_data is not data
assert new_data == {"attr[]": [1, 2, 3]}
assert files == {}


def test_transform_types_not_params_array():
data = {"attr": [1, 2, 3]}
custom_types = {"attr": types.ArrayAttribute}
new_data, files = utils._transform_types(data, custom_types, transform_data=False)

assert new_data is not data
assert new_data == data
assert files == {}
[8]ページ先頭
©2009-2025 Movatter.jp