Skip to content
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

Add return types to client functions. #68

Merged
merged 11 commits into from
Oct 24, 2023
Merged

Add return types to client functions. #68

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cca4dd5
Add return types to client functions.
melwil Mar 8, 2023
487401c
Deserialize requires string type.
melwil Oct 8, 2023
9b7818d
Some new functions to add return types for. A few changed types.
melwil Oct 8, 2023
c4bbcb6
Clean up the file a bit, import all models from the models module.
melwil Oct 8, 2023
34bec97
After merge it can also return AsyncClient. Annotate init. Add bytes …
melwil Oct 23, 2023
758f6fa
Add return types to AsyncClient.
melwil Oct 23, 2023
add71cb
Add return type none to downliad_file.
melwil Oct 23, 2023
e737fab
Use older style type annotations for lists and dicts.
melwil Oct 23, 2023
15a8f05
Need to use Union for mixed return types.
melwil Oct 24, 2023
094116e
An import had snuck in twice in rebase.
melwil Oct 24, 2023
1390c23
Use self.serializer.deserialize instead of self.deserialize.
melwil Oct 24, 2023
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
39 changes: 20 additions & 19 deletions src/onepasswordconnectsdk/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import httpx
from httpx import HTTPError
import json
from typing import Dict, List, Union
import os

from onepasswordconnectsdk.serializer import Serializer
Expand All @@ -10,29 +11,29 @@
FailedToRetrieveItemException,
FailedToRetrieveVaultException,
)
from onepasswordconnectsdk.models import Item, ItemVault
from onepasswordconnectsdk.models import File, Item, ItemVault, SummaryItem, Vault


class AsyncClient:
"""Python Async Client Class"""

def __init__(self, url: str, token: str):
def __init__(self, url: str, token: str) -> None:
"""Initialize async client"""
self.url = url
self.token = token
self.session = self.create_session(url, token)
self.serializer = Serializer()

def create_session(self, url: str, token: str):
def create_session(self, url: str, token: str) -> httpx.AsyncClient:
return httpx.AsyncClient(base_url=url, headers=self.build_headers(token))

def build_headers(self, token: str):
def build_headers(self, token: str) -> Dict[str, str]:
return build_headers(token)

async def __aexit__(self):
await self.session.aclose()

async def get_file(self, file_id: str, item_id: str, vault_id: str):
async def get_file(self, file_id: str, item_id: str, vault_id: str) -> File:
url = PathBuilder().vaults(vault_id).items(item_id).files(file_id).build()
response = await self.build_request("GET", url)
try:
Expand All @@ -44,7 +45,7 @@ async def get_file(self, file_id: str, item_id: str, vault_id: str):
)
return self.serializer.deserialize(response.content, "File")

async def get_files(self, item_id: str, vault_id: str):
async def get_files(self, item_id: str, vault_id: str) -> List[File]:
url = PathBuilder().vaults(vault_id).items(item_id).files().build()
response = await self.build_request("GET", url)
try:
Expand All @@ -56,7 +57,7 @@ async def get_files(self, item_id: str, vault_id: str):
)
return self.serializer.deserialize(response.content, "list[File]")

async def get_file_content(self, file_id: str, item_id: str, vault_id: str, content_path: str = None):
async def get_file_content(self, file_id: str, item_id: str, vault_id: str, content_path: str = None) -> Union[bytes, str]:
url = content_path
if content_path is None:
url = PathBuilder().vaults(vault_id).items(item_id).files(file_id).content().build()
Expand All @@ -70,7 +71,7 @@ async def get_file_content(self, file_id: str, item_id: str, vault_id: str, cont
)
return response.content

async def download_file(self, file_id: str, item_id: str, vault_id: str, path: str):
async def download_file(self, file_id: str, item_id: str, vault_id: str, path: str) -> None:
file_object = await self.get_file(file_id, item_id, vault_id)
filename = file_object.name or "1password_item_file.txt"
content = await self.get_file_content(file_id, item_id, vault_id, file_object.content_path)
Expand All @@ -80,7 +81,7 @@ async def download_file(self, file_id: str, item_id: str, vault_id: str, path: s
file.write(content)
file.close()

async def get_item(self, item: str, vault: str):
async def get_item(self, item: str, vault: str) -> Item:
"""Get a specific item

Args:
Expand All @@ -105,7 +106,7 @@ async def get_item(self, item: str, vault: str):
else:
return await self.get_item_by_title(item, vault_id)

async def get_item_by_id(self, item_id: str, vault_id: str):
async def get_item_by_id(self, item_id: str, vault_id: str) -> Item:
"""Get a specific item by uuid

Args:
Expand All @@ -130,7 +131,7 @@ async def get_item_by_id(self, item_id: str, vault_id: str):
)
return self.serializer.deserialize(response.content, "Item")

async def get_item_by_title(self, title: str, vault_id: str):
async def get_item_by_title(self, title: str, vault_id: str) -> Item:
"""Get a specific item by title

Args:
Expand Down Expand Up @@ -164,7 +165,7 @@ async def get_item_by_title(self, title: str, vault_id: str):
item_summary = self.serializer.deserialize(response.content, "list[SummaryItem]")[0]
return await self.get_item_by_id(item_summary.id, vault_id)

async def get_items(self, vault_id: str, filter_query: str = None):
async def get_items(self, vault_id: str, filter_query: str = None) -> List[SummaryItem]:
"""Returns a list of item summaries for the specified vault

Args:
Expand Down Expand Up @@ -192,7 +193,7 @@ async def get_items(self, vault_id: str, filter_query: str = None):

return self.serializer.deserialize(response.content, "list[SummaryItem]")

async def delete_item(self, item_id: str, vault_id: str):
async def delete_item(self, item_id: str, vault_id: str) -> None:
"""Deletes a specified item from a specified vault

Args:
Expand All @@ -214,7 +215,7 @@ async def delete_item(self, item_id: str, vault_id: str):
for {url} with message: {response.json().get('message')}"
)

async def create_item(self, vault_id: str, item: Item):
async def create_item(self, vault_id: str, item: Item) -> Item:
"""Creates an item at the specified vault

Args:
Expand All @@ -240,7 +241,7 @@ async def create_item(self, vault_id: str, item: Item):
)
return self.serializer.deserialize(response.content, "Item")

async def update_item(self, item_uuid: str, vault_id: str, item: Item):
async def update_item(self, item_uuid: str, vault_id: str, item: Item) -> Item:
"""Update the specified item at the specified vault.

Args:
Expand Down Expand Up @@ -269,7 +270,7 @@ async def update_item(self, item_uuid: str, vault_id: str, item: Item):
)
return self.serializer.deserialize(response.content, "Item")

async def get_vault(self, vault_id: str):
async def get_vault(self, vault_id: str) -> Vault:
"""Returns the vault with the given vault_id

Args:
Expand All @@ -294,7 +295,7 @@ async def get_vault(self, vault_id: str):

return self.serializer.deserialize(response.content, "Vault")

async def get_vault_by_title(self, name: str):
async def get_vault_by_title(self, name: str) -> Vault:
"""Returns the vault with the given name

Args:
Expand Down Expand Up @@ -326,7 +327,7 @@ async def get_vault_by_title(self, name: str):

return self.serializer.deserialize(response.content, "list[Vault]")[0]

async def get_vaults(self):
async def get_vaults(self) -> List[Vault]:
"""Returns all vaults for service account set in client

Raises:
Expand All @@ -348,7 +349,7 @@ async def get_vaults(self):

return self.serializer.deserialize(response.content, "list[Vault]")

def build_request(self, method: str, path: str, body=None):
def build_request(self, method: str, path: str, body=None) -> httpx.Response:
"""Builds a http request
Parameters:
method (str): The rest method to be used
Expand Down
69 changes: 35 additions & 34 deletions src/onepasswordconnectsdk/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import httpx
from httpx import HTTPError
import json
from typing import Dict, List, Union
import os

from onepasswordconnectsdk.async_client import AsyncClient
Expand All @@ -13,7 +14,7 @@
EnvironmentHostNotSetException,
EnvironmentTokenNotSetException,
)
from onepasswordconnectsdk.models import Item, ItemVault
from onepasswordconnectsdk.models import File, Item, ItemVault, SummaryItem, Vault
from onepasswordconnectsdk.models.constants import CONNECT_HOST_ENV_VARIABLE

ENV_SERVICE_ACCOUNT_JWT_VARIABLE = "OP_CONNECT_TOKEN"
Expand All @@ -23,23 +24,23 @@
class Client:
"""Python Client Class"""

def __init__(self, url: str, token: str):
def __init__(self, url: str, token: str) -> None:
"""Initialize client"""
self.url = url
self.token = token
self.session = self.create_session(url, token)
melwil marked this conversation as resolved.
Show resolved Hide resolved
self.serializer = Serializer()

def create_session(self, url: str, token: str):
def create_session(self, url: str, token: str) -> httpx.Client:
return httpx.Client(base_url=url, headers=self.build_headers(token))

def build_headers(self, token: str):
def build_headers(self, token: str) -> Dict[str, str]:
return build_headers(token)

def __del__(self):
def __del__(self) -> None:
self.session.close()

def get_file(self, file_id: str, item_id: str, vault_id: str):
def get_file(self, file_id: str, item_id: str, vault_id: str) -> File:
url = PathBuilder().vaults(vault_id).items(item_id).files(file_id).build()
response = self.build_request("GET", url)
try:
Expand All @@ -49,9 +50,9 @@ def get_file(self, file_id: str, item_id: str, vault_id: str):
f"Unable to retrieve item. Received {response.status_code}\
for {url} with message: {response.json().get('message')}"
)
return self.serializer.deserialize(response.content, "File")
return self.deserialize(response.content, "File")
melwil marked this conversation as resolved.
Show resolved Hide resolved

def get_files(self, item_id: str, vault_id: str):
def get_files(self, item_id: str, vault_id: str) -> List[File]:
url = PathBuilder().vaults(vault_id).items(item_id).files().build()
response = self.build_request("GET", url)
try:
Expand All @@ -61,9 +62,9 @@ def get_files(self, item_id: str, vault_id: str):
f"Unable to retrieve item. Received {response.status_code}\
for {url} with message: {response.json().get('message')}"
)
return self.serializer.deserialize(response.content, "list[File]")
return self.deserialize(response.content, "list[File]")

def get_file_content(self, file_id: str, item_id: str, vault_id: str, content_path: str = None):
def get_file_content(self, file_id: str, item_id: str, vault_id: str, content_path: str = None) -> Union[bytes, str]:
url = content_path
if content_path is None:
url = PathBuilder().vaults(vault_id).items(item_id).files(file_id).content().build()
Expand All @@ -77,7 +78,7 @@ def get_file_content(self, file_id: str, item_id: str, vault_id: str, content_pa
)
return response.content

def download_file(self, file_id: str, item_id: str, vault_id: str, path: str):
def download_file(self, file_id: str, item_id: str, vault_id: str, path: str) -> None:
file_object = self.get_file(file_id, item_id, vault_id)
filename = file_object.name or "1password_item_file.txt"
content = self.get_file_content(file_id, item_id, vault_id, file_object.content_path)
Expand All @@ -87,7 +88,7 @@ def download_file(self, file_id: str, item_id: str, vault_id: str, path: str):
file.write(content)
file.close()

def get_item(self, item: str, vault: str):
def get_item(self, item: str, vault: str) -> Item:
"""Get a specific item

Args:
Expand All @@ -111,9 +112,9 @@ def get_item(self, item: str, vault: str):
else:
return self.get_item_by_title(item, vault_id)

def get_item_by_id(self, item_id: str, vault_id: str):
def get_item_by_id(self, item_id: str, vault_id: str) -> Item:
"""Get a specific item by uuid

Args:
item_id (str): The id of the item to be fetched
vault_id (str): The id of the vault in which to get the item from
Expand All @@ -134,11 +135,11 @@ def get_item_by_id(self, item_id: str, vault_id: str):
f"Unable to retrieve item. Received {response.status_code}\
for {url} with message: {response.json().get('message')}"
)
return self.serializer.deserialize(response.content, "Item")
return self.deserialize(response.content, "Item")

def get_item_by_title(self, title: str, vault_id: str):
def get_item_by_title(self, title: str, vault_id: str) -> Item:
"""Get a specific item by title

Args:
title (str): The title of the item to be fetched
vault_id (str): The id of the vault in which to get the item from
Expand Down Expand Up @@ -170,7 +171,7 @@ def get_item_by_title(self, title: str, vault_id: str):
item_summary = self.serializer.deserialize(response.content, "list[SummaryItem]")[0]
return self.get_item_by_id(item_summary.id, vault_id)

def get_items(self, vault_id: str, filter_query: str = None):
def get_items(self, vault_id: str, filter_query: str = None) -> List[SummaryItem]:
"""Returns a list of item summaries for the specified vault

Args:
Expand Down Expand Up @@ -198,9 +199,9 @@ def get_items(self, vault_id: str, filter_query: str = None):
for {url} with message: {response.json().get('message')}"
)

return self.serializer.deserialize(response.content, "list[SummaryItem]")
return self.deserialize(response.content, "list[SummaryItem]")

def delete_item(self, item_id: str, vault_id: str):
def delete_item(self, item_id: str, vault_id: str) -> None:
"""Deletes a specified item from a specified vault

Args:
Expand All @@ -221,7 +222,7 @@ def delete_item(self, item_id: str, vault_id: str):
for {url} with message: {response.json().get('message')}"
)

def create_item(self, vault_id: str, item: Item):
def create_item(self, vault_id: str, item: Item) -> Item:
"""Creates an item at the specified vault

Args:
Expand All @@ -245,9 +246,9 @@ def create_item(self, vault_id: str, item: Item):
f"Unable to post item. Received {response.status_code}\
for {url} with message: {response.json().get('message')}"
)
return self.serializer.deserialize(response.content, "Item")
return self.deserialize(response.content, "Item")

def update_item(self, item_uuid: str, vault_id: str, item: Item):
def update_item(self, item_uuid: str, vault_id: str, item: Item) -> Item:
"""Update the specified item at the specified vault.

Args:
Expand All @@ -274,9 +275,9 @@ def update_item(self, item_uuid: str, vault_id: str, item: Item):
f"Unable to post item. Received {response.status_code}\
for {url} with message: {response.json().get('message')}"
)
return self.serializer.deserialize(response.content, "Item")
return self.deserialize(response.content, "Item")

def get_vault(self, vault_id: str):
def get_vault(self, vault_id: str) -> Vault:
"""Returns the vault with the given vault_id

Args:
Expand All @@ -299,14 +300,14 @@ def get_vault(self, vault_id: str):
for {url} with message {response.json().get('message')}"
)

return self.serializer.deserialize(response.content, "Vault")
return self.deserialize(response.content, "Vault")

def get_vault_by_title(self, name: str):
def get_vault_by_title(self, name: str) -> Vault:
"""Returns the vault with the given name

Args:
name (str): The name of the vault in which to fetch

Raises:
FailedToRetrieveVaultException: Thrown when a HTTP error is
returned from the 1Password Connect API
Expand All @@ -333,7 +334,7 @@ def get_vault_by_title(self, name: str):

return self.serializer.deserialize(response.content, "list[Vault]")[0]

def get_vaults(self):
def get_vaults(self) -> List[Vault]:
"""Returns all vaults for service account set in client

Raises:
Expand All @@ -353,9 +354,9 @@ def get_vaults(self):
for {url} with message {response.json().get('message')}"
)

return self.serializer.deserialize(response.content, "list[Vault]")
return self.deserialize(response.content, "list[Vault]")

def build_request(self, method: str, path: str, body=None):
def build_request(self, method: str, path: str, body=None) -> httpx.Response:
"""Builds a http request
Parameters:
method (str): The rest method to be used
Expand All @@ -380,7 +381,7 @@ def sanitize_for_serialization(self, obj):
return self.serializer.sanitize_for_serialization(obj)


def new_client(url: str, token: str, is_async: bool = False):
def new_client(url: str, token: str, is_async: bool = False) -> Union[AsyncClient, Client]:
"""Builds a new client for interacting with 1Password Connect
Parameters:
url: The url of the 1Password Connect API
Expand All @@ -395,7 +396,7 @@ def new_client(url: str, token: str, is_async: bool = False):
return Client(url, token)


def new_client_from_environment(url: str = None):
def new_client_from_environment(url: str = None) -> Union[AsyncClient, Client]:
"""Builds a new client for interacting with 1Password Connect
using the OP_TOKEN environment variable

Expand Down
Loading