Skip to content

Utils

Opath

Bases: NativePath

Custom Path class, inherit from system native Path class, keep all original features and add custom methods.

Source code in src\omoospace\utils.py 
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
class Opath(NativePath):
    """
    Custom Path class, inherit from system native Path class,
    keep all original features and add custom methods.
    """

    def reveal_in_explorer(self):
        """Open the directory in file exploarer"""
        try:
            os.startfile(self)
        except Exception as err:
            print("Fail to reveal", err)

    def is_under(self, b: Union[str, Path, "Opath"], or_equal=False) -> bool:
        """Return True if a is a subpath of b .

        Args:
            b (Union[str, Path]): Parent path
            or_equal (bool, optional): [description]. Defaults to False.

        Returns:
            bool: Result.
        """
        b = Path(b).resolve()
        a = self.resolve()
        is_under = b in a.parents
        is_equal = b == a

        return is_under or is_equal if or_equal else is_under

    def get_children(self, recursive: bool = True) -> list["Opath"]:
        """Get all paths in giving directory.

        Args:
            recursive (bool, optional): Whether recursive or not. Defaults to True.
        """
        search_path: Path = self.resolve()
        paths: list[Opath] = []
        if recursive:
            # FIXME: replace this with Path.walk (python 3.12)
            # https://docs.python.org/3/library/pathlib.html
            for root, dirs, files in os.walk(search_path):
                for path in [*dirs, *files]:
                    child = Opath(root, path).resolve()
                    paths.append(child)
        else:
            for child in search_path.iterdir():
                paths.append(child)
        return paths

    def copy_to(
        self, dir: Union[str, Path, "Opath"], overwrite: bool = False
    ) -> "Opath":
        """Copy file or directory to the given directory.

        Args:
            dir (Union[str, Path, Opath]): Destination directory.
        """

        if not self.exists():
            raise FileNotFoundError(f"{self} does not exist.")

        dir = Opath(dir).resolve()
        dst = dir / self.name

        if dst.exists():
            if not overwrite:
                raise FileExistsError(f"{dst} already exists.")

            if self.resolve() == dst.resolve():
                return self

        else:
            dir.mkdir(parents=True, exist_ok=True)

        if self.is_dir():
            return Opath(shutil.copytree(self.resolve(), dst, dirs_exist_ok=True))
        else:
            return Opath(shutil.copy(self.resolve(), dir))

    def move_to(
        self, dir: Union[str, Path, "Opath"], overwrite: bool = False
    ) -> "Opath":
        """Move the file or directory to the given directory.

        Args:
            dir (Union[str, Path, Opath]): Destination directory.
        """
        if not self.exists():
            raise FileNotFoundError(f"{self} does not exist.")

        dir = Opath(dir).resolve()
        dst = dir / self.name

        if dst.exists():
            if not overwrite:
                raise FileExistsError(f"{dst} already exists.")

            if self.resolve() == dst.resolve():
                return self

            if dst.is_dir():
                shutil.rmtree(dst, ignore_errors=True)
            else:
                dst.unlink()
        else:
            dir.mkdir(parents=True, exist_ok=True)

        if dst.exists():
            dst.unlink()
        return Opath(shutil.move(self.resolve(), dir))

    def remove_children(self):
        """Remove all children in the directory."""
        dirpath = self.resolve()

        for child in dirpath.iterdir():
            Opath(child).remove()

    def remove(self):
        """Remove all files and directories in the directory."""
        if self.is_file():
            self.unlink()
        elif self.is_dir():
            shutil.rmtree(self, ignore_errors=True)
        else:
            raise ValueError(f"{self} does not exist.")

copy_to(dir, overwrite=False)

Copy file or directory to the given directory.

Parameters:

Name Type Description Default
dir Union[str, Path, Opath]

Destination directory.

 required
Source code in src\omoospace\utils.py 
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def copy_to(
    self, dir: Union[str, Path, "Opath"], overwrite: bool = False
) -> "Opath":
    """Copy file or directory to the given directory.

    Args:
        dir (Union[str, Path, Opath]): Destination directory.
    """

    if not self.exists():
        raise FileNotFoundError(f"{self} does not exist.")

    dir = Opath(dir).resolve()
    dst = dir / self.name

    if dst.exists():
        if not overwrite:
            raise FileExistsError(f"{dst} already exists.")

        if self.resolve() == dst.resolve():
            return self

    else:
        dir.mkdir(parents=True, exist_ok=True)

    if self.is_dir():
        return Opath(shutil.copytree(self.resolve(), dst, dirs_exist_ok=True))
    else:
        return Opath(shutil.copy(self.resolve(), dir))

get_children(recursive=True)

Get all paths in giving directory.

Parameters:

Name Type Description Default
recursive bool

Whether recursive or not. Defaults to True.

 True
Source code in src\omoospace\utils.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def get_children(self, recursive: bool = True) -> list["Opath"]:
    """Get all paths in giving directory.

    Args:
        recursive (bool, optional): Whether recursive or not. Defaults to True.
    """
    search_path: Path = self.resolve()
    paths: list[Opath] = []
    if recursive:
        # FIXME: replace this with Path.walk (python 3.12)
        # https://docs.python.org/3/library/pathlib.html
        for root, dirs, files in os.walk(search_path):
            for path in [*dirs, *files]:
                child = Opath(root, path).resolve()
                paths.append(child)
    else:
        for child in search_path.iterdir():
            paths.append(child)
    return paths

is_under(b, or_equal=False)

Return True if a is a subpath of b .

Parameters:

Name Type Description Default
b Union[str, Path]

Parent path

 required
or_equal bool

[description]. Defaults to False.

 False

Returns:

Name Type Description
bool bool

Result.
Source code in src\omoospace\utils.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
def is_under(self, b: Union[str, Path, "Opath"], or_equal=False) -> bool:
    """Return True if a is a subpath of b .

    Args:
        b (Union[str, Path]): Parent path
        or_equal (bool, optional): [description]. Defaults to False.

    Returns:
        bool: Result.
    """
    b = Path(b).resolve()
    a = self.resolve()
    is_under = b in a.parents
    is_equal = b == a

    return is_under or is_equal if or_equal else is_under

move_to(dir, overwrite=False)

Move the file or directory to the given directory.

Parameters:

Name Type Description Default
dir Union[str, Path, Opath]

Destination directory.

 required
Source code in src\omoospace\utils.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
def move_to(
    self, dir: Union[str, Path, "Opath"], overwrite: bool = False
) -> "Opath":
    """Move the file or directory to the given directory.

    Args:
        dir (Union[str, Path, Opath]): Destination directory.
    """
    if not self.exists():
        raise FileNotFoundError(f"{self} does not exist.")

    dir = Opath(dir).resolve()
    dst = dir / self.name

    if dst.exists():
        if not overwrite:
            raise FileExistsError(f"{dst} already exists.")

        if self.resolve() == dst.resolve():
            return self

        if dst.is_dir():
            shutil.rmtree(dst, ignore_errors=True)
        else:
            dst.unlink()
    else:
        dir.mkdir(parents=True, exist_ok=True)

    if dst.exists():
        dst.unlink()
    return Opath(shutil.move(self.resolve(), dir))

remove()

Remove all files and directories in the directory.

Source code in src\omoospace\utils.py 
145
146
147
148
149
150
151
152
def remove(self):
    """Remove all files and directories in the directory."""
    if self.is_file():
        self.unlink()
    elif self.is_dir():
        shutil.rmtree(self, ignore_errors=True)
    else:
        raise ValueError(f"{self} does not exist.")

remove_children()

Remove all children in the directory.

Source code in src\omoospace\utils.py 
138
139
140
141
142
143
def remove_children(self):
    """Remove all children in the directory."""
    dirpath = self.resolve()

    for child in dirpath.iterdir():
        Opath(child).remove()

reveal_in_explorer()

Open the directory in file exploarer

Source code in src\omoospace\utils.py 
32
33
34
35
36
37
def reveal_in_explorer(self):
    """Open the directory in file exploarer"""
    try:
        os.startfile(self)
    except Exception as err:
        print("Fail to reveal", err)

Oset

Bases: Generic[T], set

Universal set implementation compatible with both primitive types (str/int/float/bool) and custom objects (enforcing uniqueness via a specified attribute).

Key Features
  • Primitive types: Behaves exactly like native Python set
  • Custom objects: Enforces uniqueness using specified attribute (default: "name")
  • Supports membership checks with both attribute values (str/int) and object instances
  • Supports equality comparison with native sets (e.g., Oset[Maker] == {"Alice", "Bob"})

Attributes:

Name Type Description
key

Name of attribute used for uniqueness checks on custom objects (default: "name") Ignored for primitive type elements
Source code in src\omoospace\utils.py 
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
class Oset(Generic[T], set):
    """
    Universal set implementation compatible with both primitive types (str/int/float/bool)
    and custom objects (enforcing uniqueness via a specified attribute).

    Key Features:
        - Primitive types: Behaves exactly like native Python set
        - Custom objects: Enforces uniqueness using specified attribute (default: "name")
        - Supports membership checks with both attribute values (str/int) and object instances
        - Supports equality comparison with native sets (e.g., Oset[Maker] == {"Alice", "Bob"})

    Attributes:
        key: Name of attribute used for uniqueness checks on custom objects (default: "name")
             Ignored for primitive type elements
    """

    def __init__(self, iterable: Iterable[T] = (), key: str = "name"):
        """
        Initialize Oset with automatic deduplication based on element type.

        Args:
            iterable: Iterable containing primitive values (str/int) or custom objects (default: empty)
            key: Attribute name for uniqueness validation on custom objects (default: "name")

        Raises:
            ValueError: If custom objects lack the specified key attribute
        """
        self.key = key
        unique_items = []
        seen_keys = set()

        for item in iterable:
            item_key = self._get_item_key(item)
            if item_key not in seen_keys:
                seen_keys.add(item_key)
                unique_items.append(item)

        super().__init__(unique_items)

    def _get_item_key(self, item: T) -> Union[str, int, float, bool]:
        """
        Get unique identity key for an element.

        For primitive types (str/int/float/bool): Returns the element itself
        For custom objects: Returns the value of the specified key attribute

        Args:
            item: Primitive value or custom object to get key for

        Returns:
            Union[str, int, float, bool]: Unique identity key

        Raises:
            ValueError: If custom object lacks the specified key attribute
        """
        if isinstance(item, (str, int, float, bool)):
            return item
        try:
            return getattr(item, self.key)
        except AttributeError:
            raise ValueError(f"Object {item} missing required attribute '{self.key}'")

    def __contains__(self, item: Any) -> bool:
        """
        Override membership operator ('in') with type-aware logic.

        Logic:
            1. Custom object collection: Check by attribute value (str/int) or object instance
            2. Primitive type collection: Maintain native set membership behavior

        Args:
            item: Attribute value (str/int) or object to check membership for

        Returns:
            bool: True if item exists in set, False otherwise
        """
        # Check if collection contains custom objects (not primitives)
        if self and not isinstance(next(iter(self)), (str, int, float, bool)):
            # Case 1: Check by attribute value (e.g., "Alice" for Maker object)
            if isinstance(item, (str, int, float, bool)):
                return any(self._get_item_key(obj) == item for obj in self)

            # Case 2: Check by object instance (compare key attributes)
            else:
                try:
                    item_key = self._get_item_key(item)
                    print(item_key)
                except ValueError:
                    return False
                return any(self._get_item_key(obj) == item_key for obj in self)
        # Primitive type collection - use native set behavior
        else:
            return super().__contains__(item)

    def __eq__(self, other: Any) -> bool:
        """
        Universal equality operator (==) for all Oset types (NO primitive exceptions).

        Compares key-based native sets for equality, enabling cross-type comparisons:
        - Oset[Maker] == {"Alice", "Bob"}
        - Oset[str] == {"Alice", "Bob"}
        - Oset[int] == {1, 2}

        Args:
            other: Object to compare with (native set, list, tuple, Oset, etc.)

        Returns:
            bool: True if key-based sets are equal, False otherwise
        """
        # Convert self to key-based native set (works for ALL Oset types)
        self_key_set = self.to_set()

        # Convert "other" to a native set (handle iterables/lists/tuples)
        if isinstance(other, (set, list, tuple, Oset)):
            # For Oset instances: use their to_set() method
            if isinstance(other, Oset):
                other_key_set = other.to_set()
            # For native iterables: convert directly to set
            else:
                other_key_set = set(other)
        # For non-iterable objects: return False immediately
        else:
            return False

        # Compare key-based sets (universal logic for all types)
        return self_key_set == other_key_set

    def add(self, item: T) -> None:
        """
        Add element to set with automatic deduplication.

        Args:
            item: Primitive value or custom object to add

        Raises:
            ValueError: If custom object lacks the specified key attribute
        """
        item_key = self._get_item_key(item)
        if item_key not in self:
            super().add(item)

    def update(self, *iterables: Iterable[T]) -> None:
        """
        Update set by adding multiple elements from one or more iterables.

        Maintains deduplication based on key attribute for custom objects.

        Args:
            iterables: One or more iterables containing primitives/objects

        Raises:
            ValueError: If custom objects lack the specified key attribute
        """
        for iterable in iterables:
            for item in iterable:
                self.add(item)

    def get(self, item: Any) -> Optional[T]:
        """
        Look up and return an element from the set.

        Supports lookup by:
            - Attribute value (str/int) for custom object collections
            - Exact value for primitive collections
            - Object instance for custom object collections

        Args:
            item: Attribute value (str/int) or object to find

        Returns:
            Optional[T]: Found element (primitive/object) or None if not found
        """
        # Custom object collection lookup
        if self and not isinstance(next(iter(self)), (str, int, float, bool)):
            if isinstance(item, (str, int, float, bool)):
                for obj in self:
                    if self._get_item_key(obj) == item:
                        return obj
            else:
                try:
                    item_key = self._get_item_key(item)
                except ValueError:
                    return None
                for obj in self:
                    if self._get_item_key(obj) == item_key:
                        return obj
        # Primitive collection lookup
        else:
            for obj in self:
                if obj == item:
                    return obj
        return None

    def remove(self, item: Any) -> None:
        """
        Remove element from set (raises KeyError if not found).

        Supports removal by attribute value (str/int) or object instance.

        Args:
            item: Attribute value (str/int) or object to remove

        Raises:
            KeyError: If element is not found in the set
        """
        target_item = self.get(item)
        if target_item is None:
            raise KeyError(item)
        super().remove(target_item)

    def discard(self, item: Any) -> None:
        """
        Remove element from set if present (no error if missing).

        Supports removal by attribute value (str/int) or object instance.

        Args:
            item: Attribute value (str/int) or object to remove
        """
        target_item = self.get(item)
        if target_item is not None:
            super().discard(target_item)

    def pop(self) -> T:
        """
        Remove and return an arbitrary element from the set.

        Returns:
            T: Removed element (primitive/object)

        Raises:
            KeyError: If set is empty
        """
        if not self:
            raise KeyError("pop from empty Oset")
        return super().pop()

    def clear(self) -> None:
        """Remove all elements from the set."""
        super().clear()

    def to_set(self) -> set[Union[str, int, float, bool]]:
        """
        Convert Oset to standard Python set.

        For custom object collections: Returns set of key attribute values
        For primitive collections: Returns identical native set

        Returns:
            set: Standard set containing primitive values or object key attributes
        """
        return {self._get_item_key(item) for item in self}

__contains__(item)

Override membership operator ('in') with type-aware logic.

Logic
  1. Custom object collection: Check by attribute value (str/int) or object instance
  2. Primitive type collection: Maintain native set membership behavior

Parameters:

Name Type Description Default
item Any

Attribute value (str/int) or object to check membership for

 required

Returns:

Name Type Description
bool bool

True if item exists in set, False otherwise
Source code in src\omoospace\utils.py 
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
def __contains__(self, item: Any) -> bool:
    """
    Override membership operator ('in') with type-aware logic.

    Logic:
        1. Custom object collection: Check by attribute value (str/int) or object instance
        2. Primitive type collection: Maintain native set membership behavior

    Args:
        item: Attribute value (str/int) or object to check membership for

    Returns:
        bool: True if item exists in set, False otherwise
    """
    # Check if collection contains custom objects (not primitives)
    if self and not isinstance(next(iter(self)), (str, int, float, bool)):
        # Case 1: Check by attribute value (e.g., "Alice" for Maker object)
        if isinstance(item, (str, int, float, bool)):
            return any(self._get_item_key(obj) == item for obj in self)

        # Case 2: Check by object instance (compare key attributes)
        else:
            try:
                item_key = self._get_item_key(item)
                print(item_key)
            except ValueError:
                return False
            return any(self._get_item_key(obj) == item_key for obj in self)
    # Primitive type collection - use native set behavior
    else:
        return super().__contains__(item)

__eq__(other)

Universal equality operator (==) for all Oset types (NO primitive exceptions).

Compares key-based native sets for equality, enabling cross-type comparisons: - Oset[Maker] == {"Alice", "Bob"} - Oset[str] == {"Alice", "Bob"} - Oset[int] == {1, 2}

Parameters:

Name Type Description Default
other Any

Object to compare with (native set, list, tuple, Oset, etc.)

 required

Returns:

Name Type Description
bool bool

True if key-based sets are equal, False otherwise
Source code in src\omoospace\utils.py 
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
def __eq__(self, other: Any) -> bool:
    """
    Universal equality operator (==) for all Oset types (NO primitive exceptions).

    Compares key-based native sets for equality, enabling cross-type comparisons:
    - Oset[Maker] == {"Alice", "Bob"}
    - Oset[str] == {"Alice", "Bob"}
    - Oset[int] == {1, 2}

    Args:
        other: Object to compare with (native set, list, tuple, Oset, etc.)

    Returns:
        bool: True if key-based sets are equal, False otherwise
    """
    # Convert self to key-based native set (works for ALL Oset types)
    self_key_set = self.to_set()

    # Convert "other" to a native set (handle iterables/lists/tuples)
    if isinstance(other, (set, list, tuple, Oset)):
        # For Oset instances: use their to_set() method
        if isinstance(other, Oset):
            other_key_set = other.to_set()
        # For native iterables: convert directly to set
        else:
            other_key_set = set(other)
    # For non-iterable objects: return False immediately
    else:
        return False

    # Compare key-based sets (universal logic for all types)
    return self_key_set == other_key_set

__init__(iterable=(), key='name')

Initialize Oset with automatic deduplication based on element type.

Parameters:

Name Type Description Default
iterable Iterable[T]

Iterable containing primitive values (str/int) or custom objects (default: empty)

 ()
key str

Attribute name for uniqueness validation on custom objects (default: "name")

 'name'

Raises:

Type Description
ValueError

If custom objects lack the specified key attribute
Source code in src\omoospace\utils.py 
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
def __init__(self, iterable: Iterable[T] = (), key: str = "name"):
    """
    Initialize Oset with automatic deduplication based on element type.

    Args:
        iterable: Iterable containing primitive values (str/int) or custom objects (default: empty)
        key: Attribute name for uniqueness validation on custom objects (default: "name")

    Raises:
        ValueError: If custom objects lack the specified key attribute
    """
    self.key = key
    unique_items = []
    seen_keys = set()

    for item in iterable:
        item_key = self._get_item_key(item)
        if item_key not in seen_keys:
            seen_keys.add(item_key)
            unique_items.append(item)

    super().__init__(unique_items)

add(item)

Add element to set with automatic deduplication.

Parameters:

Name Type Description Default
item T

Primitive value or custom object to add

 required

Raises:

Type Description
ValueError

If custom object lacks the specified key attribute
Source code in src\omoospace\utils.py 
394
395
396
397
398
399
400
401
402
403
404
405
406
def add(self, item: T) -> None:
    """
    Add element to set with automatic deduplication.

    Args:
        item: Primitive value or custom object to add

    Raises:
        ValueError: If custom object lacks the specified key attribute
    """
    item_key = self._get_item_key(item)
    if item_key not in self:
        super().add(item)

clear()

Remove all elements from the set.

Source code in src\omoospace\utils.py 
504
505
506
def clear(self) -> None:
    """Remove all elements from the set."""
    super().clear()

discard(item)

Remove element from set if present (no error if missing).

Supports removal by attribute value (str/int) or object instance.

Parameters:

Name Type Description Default
item Any

Attribute value (str/int) or object to remove

 required
Source code in src\omoospace\utils.py 
477
478
479
480
481
482
483
484
485
486
487
488
def discard(self, item: Any) -> None:
    """
    Remove element from set if present (no error if missing).

    Supports removal by attribute value (str/int) or object instance.

    Args:
        item: Attribute value (str/int) or object to remove
    """
    target_item = self.get(item)
    if target_item is not None:
        super().discard(target_item)

get(item)

Look up and return an element from the set.

Supports lookup by
  • Attribute value (str/int) for custom object collections
  • Exact value for primitive collections
  • Object instance for custom object collections

Parameters:

Name Type Description Default
item Any

Attribute value (str/int) or object to find

 required

Returns:

Type Description
Optional[T]

Optional[T]: Found element (primitive/object) or None if not found
Source code in src\omoospace\utils.py 
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
def get(self, item: Any) -> Optional[T]:
    """
    Look up and return an element from the set.

    Supports lookup by:
        - Attribute value (str/int) for custom object collections
        - Exact value for primitive collections
        - Object instance for custom object collections

    Args:
        item: Attribute value (str/int) or object to find

    Returns:
        Optional[T]: Found element (primitive/object) or None if not found
    """
    # Custom object collection lookup
    if self and not isinstance(next(iter(self)), (str, int, float, bool)):
        if isinstance(item, (str, int, float, bool)):
            for obj in self:
                if self._get_item_key(obj) == item:
                    return obj
        else:
            try:
                item_key = self._get_item_key(item)
            except ValueError:
                return None
            for obj in self:
                if self._get_item_key(obj) == item_key:
                    return obj
    # Primitive collection lookup
    else:
        for obj in self:
            if obj == item:
                return obj
    return None

pop()

Remove and return an arbitrary element from the set.

Returns:

Name Type Description
T T

Removed element (primitive/object)

Raises:

Type Description
KeyError

If set is empty
Source code in src\omoospace\utils.py 
490
491
492
493
494
495
496
497
498
499
500
501
502
def pop(self) -> T:
    """
    Remove and return an arbitrary element from the set.

    Returns:
        T: Removed element (primitive/object)

    Raises:
        KeyError: If set is empty
    """
    if not self:
        raise KeyError("pop from empty Oset")
    return super().pop()

remove(item)

Remove element from set (raises KeyError if not found).

Supports removal by attribute value (str/int) or object instance.

Parameters:

Name Type Description Default
item Any

Attribute value (str/int) or object to remove

 required

Raises:

Type Description
KeyError

If element is not found in the set
Source code in src\omoospace\utils.py 
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
def remove(self, item: Any) -> None:
    """
    Remove element from set (raises KeyError if not found).

    Supports removal by attribute value (str/int) or object instance.

    Args:
        item: Attribute value (str/int) or object to remove

    Raises:
        KeyError: If element is not found in the set
    """
    target_item = self.get(item)
    if target_item is None:
        raise KeyError(item)
    super().remove(target_item)

to_set()

Convert Oset to standard Python set.

For custom object collections: Returns set of key attribute values For primitive collections: Returns identical native set

Returns:

Name Type Description
set set[Union[str, int, float, bool]]

Standard set containing primitive values or object key attributes
Source code in src\omoospace\utils.py 
508
509
510
511
512
513
514
515
516
517
518
def to_set(self) -> set[Union[str, int, float, bool]]:
    """
    Convert Oset to standard Python set.

    For custom object collections: Returns set of key attribute values
    For primitive collections: Returns identical native set

    Returns:
        set: Standard set containing primitive values or object key attributes
    """
    return {self._get_item_key(item) for item in self}

update(*iterables)

Update set by adding multiple elements from one or more iterables.

Maintains deduplication based on key attribute for custom objects.

Parameters:

Name Type Description Default
iterables Iterable[T]

One or more iterables containing primitives/objects

 ()

Raises:

Type Description
ValueError

If custom objects lack the specified key attribute
Source code in src\omoospace\utils.py 
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
def update(self, *iterables: Iterable[T]) -> None:
    """
    Update set by adding multiple elements from one or more iterables.

    Maintains deduplication based on key attribute for custom objects.

    Args:
        iterables: One or more iterables containing primitives/objects

    Raises:
        ValueError: If custom objects lack the specified key attribute
    """
    for iterable in iterables:
        for item in iterable:
            self.add(item)

copy_to_clipboard(string)

Copy to clipboard

Parameters:

Name Type Description Default
string str

The string want to be copyed.

 required
Source code in src\omoospace\utils.py 
207
208
209
210
211
212
213
214
def copy_to_clipboard(string: str):
    """Copy to clipboard

    Args:
        string (str): The string want to be copyed.
    """

    pyperclip.copy(string)

make_path(*paths, under='.', overwrite=False)

Create paths.

Parameters:

Name Type Description Default
paths list[Union[str, dict[str, str]]]

The paths want to be created.

 ()
under AnyPath

The parent directory. Defaults to ".".

 '.'
Source code in src\omoospace\utils.py 
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
def make_path(
    *paths: list[Union[str, dict[str, str]]],
    under: AnyPath = ".",
    overwrite: bool = False,
):
    """Create paths.

    Args:
        paths (list[Union[str, dict[str, str]]]): The paths want to be created.
        under (AnyPath, optional): The parent directory. Defaults to ".".
    """
    maked_paths = []
    for p in paths:
        if isinstance(p, str):
            maked_path = Opath(under, p).resolve()
            if p.endswith("/"):
                maked_path.mkdir(parents=True, exist_ok=True)
            else:
                maked_path.parent.mkdir(parents=True, exist_ok=True)
                if maked_path.exists() and overwrite:
                    maked_path.remove()

                if not maked_path.exists():
                    maked_path.touch()

            maked_paths.append(maked_path)

        else:
            for path, content in p.items():
                maked_path = Opath(under, path).resolve()
                maked_path.parent.mkdir(parents=True, exist_ok=True)
                if maked_path.exists() and overwrite:
                    maked_path.remove()

                if not maked_path.exists():
                    maked_path.touch()
                    if content is None:
                        continue
                    with maked_path.open("w", encoding="utf-8") as f:
                        f.write(content)

                maked_paths.append(maked_path)

    return tuple(maked_paths) if len(maked_paths) > 1 else maked_paths[0]