Add type hints to user admin API #9521

dklimpel · 2021-03-01T21:09:14Z

Pull Request Checklist

Pull request is based on the develop branch
Pull request includes a changelog file. The entry should:
- Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
- Use markdown where necessary, mostly for code blocks.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
Pull request includes a sign off
Code style is correct (run the linters)

Signed-off-by: Dirk Klimpel dirk@klimpel.org

clokep

Mostly looks good, but I have a few questions!

synapse/rest/admin/users.py

clokep · 2021-03-02T16:41:25Z

synapse/rest/admin/users.py

-    async def on_GET(self, request, target_user_id):
+    async def on_GET(
+        self, request: SynapseRequest, target_user_id: str
+    ) -> Tuple[int, Optional[JsonDict]]:


Why is this one optional? I think search_users always returns a dict?

IMO it can be None if search returns an empty result.

synapse/synapse/storage/databases/main/__init__.py

Lines 356 to 372 in aee1076

async def search_users(self, term: str) -> Optional[List[Dict[str, Any]]]:

"""Function to search users list for one or more users with

the matched term.

Args:

term: search term

Returns:

A list of dictionaries or None.

"""

return await self.db_pool.simple_search_list(

table="users",

term=term,

col="name",

retcols=["name", "password_hash", "is_guest", "admin", "user_type"],

desc="search_users",

)

Ah! I was looking at the handler code. 👍 This is why adding the type hints is useful!

synapse/storage/databases/main/__init__.py

clokep

LGTM! Thank you!

@dklimpel

Synapse 1.29.0 (2021-03-08) =========================== Note that synapse now expects an `X-Forwarded-Proto` header when used with a reverse proxy. Please see [UPGRADE.rst](UPGRADE.rst#upgrading-to-v1290) for more details on this change. No significant changes. Synapse 1.29.0rc1 (2021-03-04) ============================== Features -------- - Add rate limiters to cross-user key sharing requests. ([\#8957](matrix-org/synapse#8957)) - Add `order_by` to the admin API `GET /_synapse/admin/v1/users/<user_id>/media`. Contributed by @dklimpel. ([\#8978](matrix-org/synapse#8978)) - Add some configuration settings to make users' profile data more private. ([\#9203](matrix-org/synapse#9203)) - The `no_proxy` and `NO_PROXY` environment variables are now respected in proxied HTTP clients with the lowercase form taking precedence if both are present. Additionally, the lowercase `https_proxy` environment variable is now respected in proxied HTTP clients on top of existing support for the uppercase `HTTPS_PROXY` form and takes precedence if both are present. Contributed by Timothy Leung. ([\#9372](matrix-org/synapse#9372)) - Add a configuration option, `user_directory.prefer_local_users`, which when enabled will make it more likely for users on the same server as you to appear above other users. ([\#9383](matrix-org/synapse#9383), [\#9385](matrix-org/synapse#9385)) - Add support for regenerating thumbnails if they have been deleted but the original image is still stored. ([\#9438](matrix-org/synapse#9438)) - Add support for `X-Forwarded-Proto` header when using a reverse proxy. ([\#9472](matrix-org/synapse#9472), [\#9501](matrix-org/synapse#9501), [\#9512](matrix-org/synapse#9512), [\#9539](matrix-org/synapse#9539)) Bugfixes -------- - Fix a bug where users' pushers were not all deleted when they deactivated their account. ([\#9285](matrix-org/synapse#9285), [\#9516](matrix-org/synapse#9516)) - Fix a bug where a lot of unnecessary presence updates were sent when joining a room. ([\#9402](matrix-org/synapse#9402)) - Fix a bug that caused multiple calls to the experimental `shared_rooms` endpoint to return stale results. ([\#9416](matrix-org/synapse#9416)) - Fix a bug in single sign-on which could cause a "No session cookie found" error. ([\#9436](matrix-org/synapse#9436)) - Fix bug introduced in v1.27.0 where allowing a user to choose their own username when logging in via single sign-on did not work unless an `idp_icon` was defined. ([\#9440](matrix-org/synapse#9440)) - Fix a bug introduced in v1.26.0 where some sequences were not properly configured when running `synapse_port_db`. ([\#9449](matrix-org/synapse#9449)) - Fix deleting pushers when using sharded pushers. ([\#9465](matrix-org/synapse#9465), [\#9466](matrix-org/synapse#9466), [\#9479](matrix-org/synapse#9479), [\#9536](matrix-org/synapse#9536)) - Fix missing startup checks for the consistency of certain PostgreSQL sequences. ([\#9470](matrix-org/synapse#9470)) - Fix a long-standing bug where the media repository could leak file descriptors while previewing media. ([\#9497](matrix-org/synapse#9497)) - Properly purge the event chain cover index when purging history. ([\#9498](matrix-org/synapse#9498)) - Fix missing chain cover index due to a schema delta not being applied correctly. Only affected servers that ran development versions. ([\#9503](matrix-org/synapse#9503)) - Fix a bug introduced in v1.25.0 where `/_synapse/admin/join/` would fail when given a room alias. ([\#9506](matrix-org/synapse#9506)) - Prevent presence background jobs from running when presence is disabled. ([\#9530](matrix-org/synapse#9530)) - Fix rare edge case that caused a background update to fail if the server had rejected an event that had duplicate auth events. ([\#9537](matrix-org/synapse#9537)) Improved Documentation ---------------------- - Update the example systemd config to propagate reloads to individual units. ([\#9463](matrix-org/synapse#9463)) Internal Changes ---------------- - Add documentation and type hints to `parse_duration`. ([\#9432](matrix-org/synapse#9432)) - Remove vestiges of `uploads_path` configuration setting. ([\#9462](matrix-org/synapse#9462)) - Add a comment about systemd-python. ([\#9464](matrix-org/synapse#9464)) - Test that we require validated email for email pushers. ([\#9496](matrix-org/synapse#9496)) - Allow python to generate bytecode for synapse. ([\#9502](matrix-org/synapse#9502)) - Fix incorrect type hints. ([\#9515](matrix-org/synapse#9515), [\#9518](matrix-org/synapse#9518)) - Add type hints to device and event report admin API. ([\#9519](matrix-org/synapse#9519)) - Add type hints to user admin API. ([\#9521](matrix-org/synapse#9521)) - Bump the versions of mypy and mypy-zope used for static type checking. ([\#9529](matrix-org/synapse#9529))

dklimpel added 2 commits March 1, 2021 22:06

Add type hints to user admin API

a9d4cbf

add changelog

479e2e7

dklimpel marked this pull request as ready for review March 1, 2021 21:17

clokep requested a review from a team March 2, 2021 12:31

clokep suggested changes Mar 2, 2021

View reviewed changes

Update type hints after review

6e2710b

clokep self-requested a review March 2, 2021 18:48

assert user is not None

4299bb7

clokep approved these changes Mar 3, 2021

View reviewed changes

clokep merged commit d790d0d into matrix-org:develop Mar 3, 2021

dklimpel deleted the hint_user branch March 3, 2021 14:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add type hints to user admin API #9521

Add type hints to user admin API #9521

dklimpel commented Mar 1, 2021

clokep left a comment

clokep Mar 2, 2021

dklimpel Mar 2, 2021 •

edited

Loading

clokep Mar 3, 2021

clokep left a comment

	async def search_users(self, term: str) -> Optional[List[Dict[str, Any]]]:
	"""Function to search users list for one or more users with
	the matched term.

	Args:
	term: search term

	Returns:
	A list of dictionaries or None.
	"""
	return await self.db_pool.simple_search_list(
	table="users",
	term=term,
	col="name",
	retcols=["name", "password_hash", "is_guest", "admin", "user_type"],
	desc="search_users",
	)

Add type hints to user admin API #9521

Add type hints to user admin API #9521

Conversation

dklimpel commented Mar 1, 2021

Pull Request Checklist

clokep left a comment

Choose a reason for hiding this comment

clokep Mar 2, 2021

Choose a reason for hiding this comment

dklimpel Mar 2, 2021 • edited Loading

Choose a reason for hiding this comment

clokep Mar 3, 2021

Choose a reason for hiding this comment

clokep left a comment

Choose a reason for hiding this comment

dklimpel Mar 2, 2021 •

edited

Loading