Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

♻️ unify docstring style and signatures

Browse source
This commit is contained in:
Ondřej Samohel 2025-01-29 23:03:20 +01:00
parent 5eead5f66a
commit fef36a7cd9
No known key found for this signature in database
GPG key ID: 02376E18990A97C6
7 changed files with 20 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

1
client/ayon_core/pipeline/traits/color.py
View file

@ -21,6 +21,7 @@ class ColorManaged(TraitBase):
in the "current" OCIO context.
config (str): An OCIO config name defining color space.
"""
id: ClassVar[str] = "ayon.color.ColorManaged.v1"
name: ClassVar[str] = "ColorManaged"
description: ClassVar[str] = "Color Managed trait."

10
client/ayon_core/pipeline/traits/content.py
View file

@ -5,7 +5,7 @@ import contextlib
import re
# TC003 is there because Path in TYPECHECKING will fail in tests
from pathlib import Path # noqa: TCH003
from pathlib import Path # noqa: TC003
from typing import ClassVar, Generator, Optional
from pydantic import Field
@ -35,7 +35,6 @@ class MimeType(TraitBase):
description (str): Trait description.
id (str): id should be namespaced trait name with version
mime_type (str): Mime type like image/jpeg.
"""
name: ClassVar[str] = "MimeType"
@ -58,7 +57,6 @@ class LocatableContent(TraitBase):
description (str): Trait description.
id (str): id should be namespaced trait name with version
location (str): Location.
"""
name: ClassVar[str] = "LocatableContent"
@ -82,8 +80,8 @@ class FileLocation(TraitBase):
file_path (str): File path.
file_size (int): File size in bytes.
file_hash (str): File hash.
"""
name: ClassVar[str] = "FileLocation"
description: ClassVar[str] = "FileLocation Trait Model"
id: ClassVar[str] = "ayon.content.FileLocation.v1"
@ -359,7 +357,6 @@ class RootlessLocation(TraitBase):
description (str): Trait description.
id (str): id should be namespaced trait name with version
rootless_path (str): Rootless path.
"""
name: ClassVar[str] = "RootlessLocation"
@ -383,7 +380,6 @@ class Compressed(TraitBase):
description (str): Trait description.
id (str): id should be namespaced trait name with version
compression_type (str): Compression type.
"""
name: ClassVar[str] = "Compressed"
@ -422,7 +418,6 @@ class Bundle(TraitBase):
description (str): Trait description.
id (str): id should be namespaced trait name with version
items (list[list[TraitBase]]): List of representations.
"""
name: ClassVar[str] = "Bundle"
@ -460,7 +455,6 @@ class Fragment(TraitBase):
description (str): Trait description.
id (str): id should be namespaced trait name with version
parent (str): Parent representation id.
"""
name: ClassVar[str] = "Fragment"

2
client/ayon_core/pipeline/traits/cryptography.py
View file

@ -16,6 +16,7 @@ class DigitallySigned(TraitBase):
Attributes:
signature (str): Digital signature.
"""
id: ClassVar[str] = "ayon.cryptography.DigitallySigned.v1"
name: ClassVar[str] = "DigitallySigned"
description: ClassVar[str] = "Digitally signed trait."
@ -29,6 +30,7 @@ class PGPSigned(DigitallySigned):
Attributes:
signature (str): PGP signature.
"""
id: ClassVar[str] = "ayon.cryptography.PGPSigned.v1"
name: ClassVar[str] = "PGPSigned"
description: ClassVar[str] = "PGP signed trait."

14
client/ayon_core/pipeline/traits/representation.py
View file

@ -57,8 +57,8 @@ class Representation(Generic[T]):
Arguments:
name (str): Representation name. Must be unique within instance.
representation_id (str): Representation ID.
"""
_data: dict[str, T]
_module_blacklist: ClassVar[list[str]] = [
"_", "builtins", "pydantic",
@ -134,7 +134,7 @@ class Representation(Generic[T]):
"""Return the traits as items."""
return ItemsView(self._data)
def add_trait(self, trait: T, *, exists_ok: bool=False) -> None:
def add_trait(self, trait: T, *, exists_ok: bool = False) -> None:
"""Add a trait to the Representation.
Args:
@ -156,7 +156,7 @@ class Representation(Generic[T]):
self._data[trait.id] = trait
def add_traits(
self, traits: list[T], *, exists_ok: bool=False) -> None:
self, traits: list[T], *, exists_ok: bool = False) -> None:
"""Add a list of traits to the Representation.
Args:
@ -346,7 +346,7 @@ class Representation(Generic[T]):
return result
def get_traits(self,
traits: Optional[list[Type[T]]]=None
traits: Optional[list[Type[T]]] = None
) -> dict[str, T]:
"""Get a list of traits from the representation.
@ -406,8 +406,8 @@ class Representation(Generic[T]):
def __init__(
self,
name: str,
representation_id: Optional[str]=None,
traits: Optional[list[T]]=None):
representation_id: Optional[str] = None,
traits: Optional[list[T]] = None):
"""Initialize the data.
Args:
@ -639,7 +639,7 @@ class Representation(Generic[T]):
def from_dict(
cls: Type[Representation],
name: str,
representation_id: Optional[str]=None,
representation_id: Optional[str] = None,
trait_data: Optional[dict] = None) -> Representation:
"""Create a representation from a dictionary.

12
client/ayon_core/pipeline/traits/temporal.py
View file

@ -14,8 +14,6 @@ from .trait import MissingTraitError, TraitBase, TraitValidationError
if TYPE_CHECKING:
from pathlib import Path
from .content import FileLocations
from .representation import Representation
@ -132,13 +130,16 @@ class Sequence(TraitBase):
gaps_policy: Optional[GapPolicy] = Field(
default=GapPolicy.forbidden, title="Gaps Policy")
frame_padding: int = Field(..., title="Frame Padding")
frame_regex: Optional[Union[Pattern, str]] = Field(default=None, title="Frame Regex")
frame_spec: Optional[str] = Field(default=None, title="Frame Specification")
frame_regex: Optional[Union[Pattern, str]] = Field(
default=None, title="Frame Regex")
frame_spec: Optional[str] = Field(default=None,
title="Frame Specification")
@field_validator("frame_regex")
@classmethod
def validate_frame_regex(
cls, v: Optional[Union[Pattern, str]]) -> Optional[Union[Pattern, str]]:
cls, v: Optional[Union[Pattern, str]]
) -> Optional[Union[Pattern, str]]:
"""Validate frame regex."""
_v = v
if v and isinstance(v, Pattern):
@ -419,7 +420,6 @@ class Static(TraitBase):
"""Static time trait.
Used to define static time (single frame).
"""
name: ClassVar[str] = "Static"
description: ClassVar[str] = "Static Time Trait"

2
client/ayon_core/pipeline/traits/three_dimensional.py
View file

@ -24,8 +24,8 @@ class Spatial(TraitBase):
up_axis (str): Up axis.
handedness (str): Handedness.
meters_per_unit (float): Meters per unit.
"""
id: ClassVar[str] = "ayon.3d.Spatial.v1"
name: ClassVar[str] = "Spatial"
description: ClassVar[str] = "Spatial trait model."

7
client/ayon_core/pipeline/traits/two_dimensional.py
View file

@ -11,6 +11,7 @@ from .trait import TraitBase
if TYPE_CHECKING:
from .content import FileLocation, FileLocations
class Image(TraitBase):
"""Image trait model.
@ -20,7 +21,6 @@ class Image(TraitBase):
name (str): Trait name.
description (str): Trait description.
id (str): id should be namespaced trait name with version
"""
name: ClassVar[str] = "Image"
@ -40,7 +40,6 @@ class PixelBased(TraitBase):
display_window_width (int): Width of the image display window.
display_window_height (int): Height of the image display window.
pixel_aspect_ratio (float): Pixel aspect ratio.
"""
name: ClassVar[str] = "PixelBased"
@ -66,7 +65,6 @@ class Planar(TraitBase):
description (str): Trait description.
id (str): id should be namespaced trait name with version
planar_configuration (str): Planar configuration.
"""
name: ClassVar[str] = "Planar"
@ -84,7 +82,6 @@ class Deep(TraitBase):
name (str): Trait name.
description (str): Trait description.
id (str): id should be namespaced trait name with version
"""
name: ClassVar[str] = "Deep"
@ -106,7 +103,6 @@ class Overscan(TraitBase):
right (int): Right overscan/underscan.
top (int): Top overscan/underscan.
bottom (int): Bottom overscan/underscan.
"""
name: ClassVar[str] = "Overscan"
@ -128,7 +124,6 @@ class UDIM(TraitBase):
description (str): Trait description.
id (str): id should be namespaced trait name with version
udim (int): UDIM value.
"""
name: ClassVar[str] = "UDIM"