robin/oxibooru-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(python): refactoring python client

Browse source 
refactoring several pieces of the client and the Python wrapper to make them more usable.
This commit is contained in:
Scott Lyons 2024-08-21 08:36:59 -07:00
commit f2ae459c22
11 changed files with 275 additions and 95 deletions
Download patch file Download diff file Expand all files Collapse all files

104
szurubooru-client/src/py/asynchronous.rs
View file

@ -16,6 +16,8 @@ pub struct PythonAsyncClient {
impl PythonAsyncClient {
#[new]
#[pyo3(signature = (host, username=None, token=None, password=None, allow_insecure=None))]
///
///
pub fn new(
host: String,
username: Option<String>,
@ -57,6 +59,30 @@ impl PythonAsyncClient {
.map_err(Into::into)
}
#[pyo3(signature = (name, color=None, order=None, fields=None))]
pub async fn create_tag_category(
&self,
name: String,
color: Option<String>,
order: Option<u32>,
fields: Option<Vec<String>>,
) -> PyResult<TagCategoryResource> {
let mut cutagcat = CreateUpdateTagCategoryBuilder::default();
cutagcat.name(name);
if let Some(color) = color {
cutagcat.color(color);
}
if let Some(order) = order {
cutagcat.order(order);
}
let cutagcat = cutagcat.build()?;
self.client
.with_optional_fields(fields)
.create_tag_category(&cutagcat)
.await
.map_err(Into::into)
}
#[pyo3(signature = (name, version, color=None, order=None, fields=None))]
pub async fn update_tag_category(
&self,
@ -134,7 +160,8 @@ impl PythonAsyncClient {
#[pyo3(signature = (names, category=None, description=None, implications=None, suggestions=None, fields=None))]
pub async fn create_tag(
&self,
names: Vec<String>,
//names: Vec<String>,
names: Py<PyAny>,
category: Option<String>,
description: Option<String>,
implications: Option<Vec<String>>,
@ -142,7 +169,19 @@ impl PythonAsyncClient {
fields: Option<Vec<String>>,
) -> PyResult<TagResource> {
let mut cubuild = CreateUpdateTagBuilder::default();
cubuild.names(names);
Python::with_gil(|py| {
if let Ok(name) = names.extract::<String>(py) {
Ok(cubuild.names(vec![name]))
} else {
let list_res = names.extract::<Vec<String>>(py);
if let Ok(names) = list_res {
Ok(cubuild.names(names))
} else {
Err(list_res.err().unwrap())
}
}
})?;
//cubuild.names(names);
if let Some(cat) = category {
cubuild.category(cat);
}
@ -163,10 +202,11 @@ impl PythonAsyncClient {
.map_err(Into::into)
}
#[pyo3(signature = (name, names, category=None, description=None, implications=None, suggestions=None, fields=None))]
#[pyo3(signature = (name, version, names=None, category=None, description=None, implications=None, suggestions=None, fields=None))]
pub async fn update_tag(
&self,
name: String,
version: u32,
names: Option<Vec<String>>,
category: Option<String>,
description: Option<String>,
@ -175,6 +215,7 @@ impl PythonAsyncClient {
fields: Option<Vec<String>>,
) -> PyResult<TagResource> {
let mut cubuild = CreateUpdateTagBuilder::default();
cubuild.version(version);
if let Some(names) = names {
cubuild.names(names);
}
@ -220,7 +261,7 @@ impl PythonAsyncClient {
}
#[pyo3(signature = (remove_tag, remove_tag_version, merge_to_tag, merge_to_version, fields=None))]
pub async fn merge_tag(
pub async fn merge_tags(
&self,
remove_tag: String,
remove_tag_version: u32,
@ -236,7 +277,7 @@ impl PythonAsyncClient {
.build()?;
self.client
.with_optional_fields(fields)
.merge_tag(&mtags)
.merge_tags(&mtags)
.await
.map_err(Into::into)
}
@ -269,7 +310,7 @@ impl PythonAsyncClient {
}
#[pyo3(signature = (url=None, token=None, file_path=None, thumbnail_path=None, tags=None, safety=None, source=None,
relations=None, notes=None, flags=None, fields=None))]
relations=None, notes=None, flags=None, anonymous=None, fields=None))]
pub async fn create_post(
&self,
url: Option<String>,
@ -282,6 +323,7 @@ impl PythonAsyncClient {
relations: Option<Vec<u32>>,
notes: Option<Vec<NoteResource>>,
flags: Option<Vec<String>>,
anonymous: Option<bool>,
fields: Option<Vec<String>>,
) -> PyResult<PostResource> {
let mut cupost = CreateUpdatePostBuilder::default();
@ -303,6 +345,9 @@ impl PythonAsyncClient {
if let Some(flags) = flags {
cupost.flags(flags);
}
if let Some(anonymous) = anonymous {
cupost.anonymous(anonymous);
}
if let Some(token) = token {
cupost.content_token(token);
@ -447,7 +492,7 @@ impl PythonAsyncClient {
.map_err(Into::into)
}
pub async fn reverse_search_image(&self, image_path: PathBuf) -> PyResult<ImageSearchResult> {
pub async fn reverse_image_search(&self, image_path: PathBuf) -> PyResult<ImageSearchResult> {
self.client
.request()
.reverse_search_file_path(image_path)
@ -458,7 +503,7 @@ impl PythonAsyncClient {
pub async fn post_for_image(&self, image_path: PathBuf) -> PyResult<Option<PostResource>> {
self.client
.request()
.posts_for_file_path(image_path)
.post_for_file_path(image_path)
.await
.map_err(Into::into)
}
@ -493,13 +538,14 @@ impl PythonAsyncClient {
}
#[pyo3(signature = (remove_post, remove_post_version, merge_to_post,
merge_to_version, fields=None))]
merge_to_version, replace_post_content=false, fields=None))]
pub async fn merge_post(
&self,
remove_post: u32,
remove_post_version: u32,
merge_to_post: u32,
merge_to_version: u32,
replace_post_content: bool,
fields: Option<Vec<String>>,
) -> PyResult<PostResource> {
let mpost = MergePostBuilder::default()
@ -507,6 +553,7 @@ impl PythonAsyncClient {
.remove_post(remove_post)
.merge_to_version(merge_to_version)
.merge_to_post(merge_to_post)
.replace_post_content(replace_post_content)
.build()?;
self.client
.with_optional_fields(fields)
@ -697,14 +744,26 @@ impl PythonAsyncClient {
#[pyo3(signature = (names, category=None, description=None, posts=None, fields=None))]
pub async fn create_pool<'py>(
&self,
names: Vec<String>,
names: Py<PyAny>,
category: Option<String>,
description: Option<String>,
posts: Option<Vec<u32>>,
fields: Option<Vec<String>>,
) -> PyResult<PoolResource> {
let mut cupool = CreateUpdatePoolBuilder::default();
cupool.names(names);
Python::with_gil(|py| {
if let Ok(name) = names.extract::<String>(py) {
Ok(cupool.names(vec![name]))
} else {
let list_res = names.extract::<Vec<String>>(py);
if let Ok(names) = list_res {
Ok(cupool.names(names))
} else {
Err(list_res.err().unwrap())
}
}
})?;
//cupool.names(names);
if let Some(cat) = category {
cupool.category(cat);
}
@ -885,15 +944,11 @@ impl PythonAsyncClient {
rating: i8,
fields: Option<Vec<String>>,
) -> PyResult<CommentResource> {
if rating < -1 || rating > 1 {
Err(PyValueError::new_err("Rating must be -1, 0, or 1"))
} else {
self.client
.with_optional_fields(fields)
.rate_comment(comment_id, rating)
.await
.map_err(Into::into)
}
self.client
.with_optional_fields(fields)
.rate_comment(comment_id, rating)
.await
.map_err(Into::into)
}
#[pyo3(signature = (query=None, fields=None, limit=None, offset=None))]
@ -1024,11 +1079,12 @@ impl PythonAsyncClient {
.map(|ur| ur.results)
}
#[pyo3(signature = (user_name, note=None, expiration_time=None, fields=None))]
#[pyo3(signature = (user_name, note=None, enabled=None, expiration_time=None, fields=None))]
pub async fn create_user_token(
&self,
user_name: String,
note: Option<String>,
enabled: Option<bool>,
expiration_time: Option<DateTime<Utc>>,
fields: Option<Vec<String>>,
) -> PyResult<UserAuthTokenResource> {
@ -1039,6 +1095,9 @@ impl PythonAsyncClient {
if let Some(etime) = expiration_time {
cutoken.expiration_time(etime);
}
if let Some(enabled) = enabled {
cutoken.enabled(enabled);
}
let cutoken = cutoken.build()?;
self.client
.with_optional_fields(fields)
@ -1137,11 +1196,12 @@ impl PythonAsyncClient {
.map_err(Into::into)
}
pub async fn upload_temporary_file(&self, file_path: PathBuf) -> PyResult<TemporaryFileUpload> {
pub async fn upload_temporary_file(&self, file_path: PathBuf) -> PyResult<String> {
self.client
.request()
.upload_temporary_file_from_path(file_path)
.await
.map_err(Into::into)
.map(|t| t.token)
}
}

8
szurubooru-client/src/py/mod.rs
View file

@ -1,6 +1,8 @@
use crate::models::PagedSearchResult;
use pyo3::exceptions::PyException;
use pyo3::prelude::*;
use pyo3::types::PyList;
use pyo3::types::PyListMethods;
pub mod asynchronous;
pub mod synchronous;
@ -20,6 +22,12 @@ impl PyPagedSearchResult {
fn __repr__(&self) -> String {
format!("{:?}", self)
}
/*fn __len__(&self) -> PyResult<usize> {
Python::with_gil(|py| {
Ok(self.results.bind_borrowed(py).len())
})
}*/
}
impl<T: IntoPy<PyObject>> From<PagedSearchResult<T>> for PyPagedSearchResult {

60
szurubooru-client/src/py/synchronous.rs
View file

@ -10,6 +10,20 @@ use std::path::{Path, PathBuf};
use tokio::runtime::{Builder, Runtime};
#[pyclass(name = "SzurubooruSyncClient")]
/// Constructor for the SzurubooruSyncClient
/// This client is completely synchronous. For the `asyncio` compatible version,
/// see [szurubooru_client.PythonAsyncClient](SzurubooruAsyncClient)
///
/// ## Arguments
/// * `host`: Base host URL for the Szurubooru instance. Should be the protocol, hostname and any port
/// E.g `http://localhost:9801`
/// * `username`: The username used to authenticate against the Szurubooru instance. Leave blank for
/// anonymous authentication
/// * `password`: The password to use for `Basic` authentication. Token authentication should
/// be preferred
/// * `token`: The token to use for `Bearer` authentication.
/// * `allow_insecure`: Disable cert validation. Disables SSL authentication
///
pub struct PythonSyncClient {
client: PythonAsyncClient,
runtime: Runtime,
@ -19,6 +33,7 @@ pub struct PythonSyncClient {
impl PythonSyncClient {
#[new]
#[pyo3(signature = (host, username=None, token=None, password=None, allow_insecure=None))]
/// This method is for creating new instances of the SzurubooruSyncClient
pub fn new(
host: String,
username: Option<String>,
@ -32,6 +47,7 @@ impl PythonSyncClient {
}
#[pyo3(signature = (fields=None))]
/// List the available tag categories
pub fn list_tag_categories(
&self,
fields: Option<Vec<String>>,
@ -40,6 +56,18 @@ impl PythonSyncClient {
.block_on(self.client.list_tag_categories(fields))
}
#[pyo3(signature = (name, color=None, order=None, fields=None))]
pub fn create_tag_category(
&self,
name: String,
color: Option<String>,
order: Option<u32>,
fields: Option<Vec<String>>,
) -> PyResult<TagCategoryResource> {
self.runtime
.block_on(self.client.create_tag_category(name, color, order, fields))
}
#[pyo3(signature = (name, version, color=None, order=None, fields=None))]
pub fn update_tag_category(
&self,
@ -90,7 +118,8 @@ impl PythonSyncClient {
#[pyo3(signature = (names, category=None, description=None, implications=None, suggestions=None, fields=None))]
pub fn create_tag(
&self,
names: Vec<String>,
//names: Vec<String>,
names: Py<PyAny>,
category: Option<String>,
description: Option<String>,
implications: Option<Vec<String>>,
@ -107,10 +136,12 @@ impl PythonSyncClient {
))
}
#[pyo3(signature = (name, names, category=None, description=None, implications=None, suggestions=None, fields=None))]
#[pyo3(signature = (name, version, names=None, category=None, description=None,
implications=None, suggestions=None, fields=None))]
pub fn update_tag(
&self,
name: String,
version: u32,
names: Option<Vec<String>>,
category: Option<String>,
description: Option<String>,
@ -120,6 +151,7 @@ impl PythonSyncClient {
) -> PyResult<TagResource> {
self.runtime.block_on(self.client.update_tag(
name,
version,
names,
category,
description,
@ -139,7 +171,7 @@ impl PythonSyncClient {
}
#[pyo3(signature = (remove_tag, remove_tag_version, merge_to_tag, merge_to_version, fields=None))]
pub fn merge_tag(
pub fn merge_tags(
&self,
remove_tag: String,
remove_tag_version: u32,
@ -147,7 +179,7 @@ impl PythonSyncClient {
merge_to_version: u32,
fields: Option<Vec<String>>,
) -> PyResult<TagResource> {
self.runtime.block_on(self.client.merge_tag(
self.runtime.block_on(self.client.merge_tags(
remove_tag,
remove_tag_version,
merge_to_tag,
@ -173,7 +205,7 @@ impl PythonSyncClient {
}
#[pyo3(signature = (url=None, token=None, file_path=None, thumbnail_path=None, tags=None, safety=None, source=None,
relations=None, notes=None, flags=None, fields=None))]
relations=None, notes=None, flags=None, anonymous=None, fields=None))]
pub fn create_post(
&self,
url: Option<String>,
@ -186,6 +218,7 @@ impl PythonSyncClient {
relations: Option<Vec<u32>>,
notes: Option<Vec<NoteResource>>,
flags: Option<Vec<String>>,
anonymous: Option<bool>,
fields: Option<Vec<String>>,
) -> PyResult<PostResource> {
self.runtime.block_on(self.client.create_post(
@ -199,6 +232,7 @@ impl PythonSyncClient {
relations,
notes,
flags,
anonymous,
fields,
))
}
@ -258,9 +292,9 @@ impl PythonSyncClient {
.block_on(self.client.download_thumbnail_to_path(post_id, file_path))
}
pub fn reverse_search_image(&self, image_path: PathBuf) -> PyResult<ImageSearchResult> {
pub fn reverse_image_search(&self, image_path: PathBuf) -> PyResult<ImageSearchResult> {
self.runtime
.block_on(self.client.reverse_search_image(image_path))
.block_on(self.client.reverse_image_search(image_path))
}
pub fn post_for_image(&self, image_path: PathBuf) -> PyResult<Option<PostResource>> {
@ -283,13 +317,14 @@ impl PythonSyncClient {
}
#[pyo3(signature = (remove_post, remove_post_version, merge_to_post,
merge_to_version, fields=None))]
merge_to_version, replace_post_content=false, fields=None))]
pub fn merge_post(
&self,
remove_post: u32,
remove_post_version: u32,
merge_to_post: u32,
merge_to_version: u32,
replace_post_content: bool,
fields: Option<Vec<String>>,
) -> PyResult<PostResource> {
self.runtime.block_on(self.client.merge_post(
@ -297,6 +332,7 @@ impl PythonSyncClient {
remove_post_version,
merge_to_post,
merge_to_version,
replace_post_content,
fields,
))
}
@ -422,7 +458,7 @@ impl PythonSyncClient {
#[pyo3(signature = (names, category=None, description=None, posts=None, fields=None))]
pub fn create_pool(
&self,
names: Vec<String>,
names: Py<PyAny>,
category: Option<String>,
description: Option<String>,
posts: Option<Vec<u32>>,
@ -622,17 +658,19 @@ impl PythonSyncClient {
.block_on(self.client.list_user_tokens(user_name, fields))
}
#[pyo3(signature = (user_name, note=None, expiration_time=None, fields=None))]
#[pyo3(signature = (user_name, note=None, enabled=None, expiration_time=None, fields=None))]
pub fn create_user_token(
&self,
user_name: String,
note: Option<String>,
enabled: Option<bool>,
expiration_time: Option<DateTime<Utc>>,
fields: Option<Vec<String>>,
) -> PyResult<UserAuthTokenResource> {
self.runtime.block_on(self.client.create_user_token(
user_name,
note,
enabled,
expiration_time,
fields,
))
@ -702,7 +740,7 @@ impl PythonSyncClient {
self.runtime.block_on(self.client.global_info())
}
pub fn upload_temporary_file(&self, file_path: PathBuf) -> PyResult<TemporaryFileUpload> {
pub fn upload_temporary_file(&self, file_path: PathBuf) -> PyResult<String> {
self.runtime
.block_on(self.client.upload_temporary_file(file_path))
}