vt-commons 0.0.1

Reusable common utilities, interfaces and implementations for python projects.

vt-commons

---

Commons methods, utils, interfaces and implementations for python projects.

Install

pip install vt-commons

Usage examples

• Check for OS

  from vt.utils.commons.commons.os import is_windows
  
  is_windows()
  

  Check in vt.utils.commons.commons.os and documentation for more functions and utilities related to OS.
• Perform some operation on a root directory

  from vt.utils.commons.commons.op import RootDirOp, CWDRootDirOp, RootDirOps
  from pathlib import Path
  
  class MyRootDirectoryOperation(RootDirOp):
      ...
      @property
      def root_dir(self)-> Path:
          return Path('path', 'to', 'my', 'root-directory')
  
  certain_root_dir_operation: CWDRootDirOp = RootDirOps.from_path(Path('path', 'to', 'my', 'root-directory'))
  

  Check in vt.utils.commons.commons.op and documentation for more functions and utilities related to operations.
• Perform state operations

  from vt.utils.commons.commons.state import DoneMarker
  
  # Track state by marking done
  class MyStateManager(DoneMarker[int]):
      def __init__(self, *args, **kwargs):
          self.id_state = {1: False}
          ...
  
      def mark_done(self, _id: int)-> bool:
          # mark done for _id
          if self.id_state[_id] is True:
              return False
          self.id_state[_id] = True
          return True
  

  Check in vt.utils.commons.commons.state and documentation for more functions and utilities related to tracking state.
• Check if a value is MISSING

  from vt.utils.commons.commons.core_py import MISSING, Missing, is_missing
  
  def some_operation(arg: Missing = MISSING):
      """
      ``MISSING`` can be used as a default value sentinel when ``None`` is a valid value for arg.
      """
      arg = 10 if is_missing(arg) else arg
      ...
  

  Check in vt.utils.commons.commons.core_py and documentation for more functions and utilities related to function management.
• Query and operate on iterables

  from vt.utils.commons.commons.collections import get_first_true
  
  assert 3 == get_first_true([1, 3, 5, 7, 2, 1], 8, lambda x: x>2)
  

  Check in vt.utils.commons.commons.collections and documentation for more functions and utilities related to collection management.

Contribute

Want to contribute?

Checkout Guidelines for contributions.