pybinlock

Contents:

  • Installation
  • Usage
    • Create a new lock
    • Read an existing lock
    • Lock a bin
      • Temporarily hold a lock
      • Indefinitely lock a bin
    • Unlock a bin
  • Best practices
    • Order of operations
      • Opening a bin unlocked
      • Closing a bin
    • Other tools
      • pybinhistory
  • API reference
    • binlock
      • Classes
        • binlock.BinLock
      • Submodules
        • binlock.defaults
        • binlock.exceptions
pybinlock
  • Index

Index

_ | B | D | F | H | L | M | N | R | T | U

_

  • __init__() (binlock.BinLock method)

B

  • binlock
    • module
  • BinLock (class in binlock)
  • binlock.defaults
    • module
  • binlock.exceptions
    • module
  • BinLockChangedError
  • BinLockExistsError
  • BinLockFileDecodeError
  • BinLockNameError
  • BinLockNotFoundError
  • BinLockOwnershipError
  • BinNotFoundError

D

  • DEFAULT_FILE_EXTENSION (in module binlock.defaults)
  • DEFAULT_LOCK_NAME (in module binlock.defaults)

F

  • from_bin() (binlock.BinLock class method)
  • from_path() (binlock.BinLock class method)

H

  • hold_bin() (binlock.BinLock method)
  • hold_lock() (binlock.BinLock method)

L

  • lock_bin() (binlock.BinLock method)
  • lock_path_from_bin_path() (binlock.BinLock static method)

M

  • MAX_NAME_LENGTH (in module binlock.defaults)
  • module
    • binlock
    • binlock.defaults
    • binlock.exceptions

N

  • name (binlock.BinLock property)

R

  • remove_path() (binlock.BinLock method)

T

  • to_path() (binlock.BinLock method)
  • TOTAL_FILE_SIZE (in module binlock.defaults)

U

  • unlock_bin() (binlock.BinLock method)

© Copyright 2025, Michael J. Jordan.

Built with Sphinx using a theme provided by Read the Docs.