snakeoil package

Subpackages

• snakeoil.chksum package
  • Submodules
    • snakeoil.chksum.defaults module
      • Chksummer
      • SizeChksummer
      • SizeUpdater
      • chf_thread()
      • chksum_loop_over_file()
      • loop_over_file()
  • Module contents
    • LazilyHashedPath
      • LazilyHashedPath.clear()
    • MissingChksumHandler
    • get_chksums()
    • get_handler()
    • get_handlers()
    • init()
• snakeoil.cli package
  • Submodules
    • snakeoil.cli.arghparse module
      • ArgparseCommand
      • ArgumentParser
      • CommaSeparatedElements
      • CommaSeparatedElementsAppend
      • CommaSeparatedNegations
      • CommaSeparatedNegationsAppend
      • CommaSeparatedValues
      • CommaSeparatedValuesAppend
      • CsvActionsParser
      • CsvHelpFormatter
      • Delayed
      • DelayedDefault
      • DelayedParse
      • DelayedValue
      • EnableDebug
      • Expansion
      • ExtendAction
      • FileType
      • ManHelpAction
      • Namespace
      • OptionalsParser
      • OrderedParse
      • ParseNonblockingStdin
      • ParseStdin
      • SortedHelpFormatter
      • StoreBool
      • SubcmdAbbrevArgumentParser
      • Verbosity
      • bounded_int()
      • create_dir()
      • existent_dir()
      • existent_path()
      • positive_int()
    • snakeoil.cli.exceptions module
      • ExitException
      • UserException
      • find_user_exception()
    • snakeoil.cli.input module
      • NoChoice
      • userquery()
    • snakeoil.cli.tool module
      • FormattingHandler
      • Tool
  • Module contents
• snakeoil.compression package
  • Module contents
    • ArComp
      • ArComp.binary
      • ArComp.default_unpack_cmd
      • ArComp.known_exts
      • ArComp.unpack()
    • ArCompError
    • compress_data()
    • compress_handle()
    • decompress_data()
    • decompress_handle()
• snakeoil.klass package
  • Submodules
    • snakeoil.klass.deprecated module
      • ImmutableInstance
      • immutable_instance()
      • inject_immutable_instance()
    • snakeoil.klass.immutable module
      • Simple
      • Strict
    • snakeoil.klass.properties module
      • jit_attr()
      • jit_attr_ext_method()
      • jit_attr_named()
      • jit_attr_none()
    • snakeoil.klass.util module
      • combine_classes()
      • copy_class_docs()
      • copy_docs()
      • get_attrs_of()
      • get_slots_of()
  • Module contents
    • DirProxy()
    • GetAttrProxy()
    • ImmutableInstance
    • SlotsPicklingMixin
    • alias
    • alias_attr()
    • alias_method()
    • aliased()
    • cached_hash()
    • cached_property()
    • cached_property_named()
    • combine_classes()
    • copy_docs()
    • generic_equality()
    • get_attrs_of()
    • get_slots_of()
    • immutable_instance()
    • inject_immutable_instance()
    • inject_richcmp_methods_from_cmp()
    • instance_attrgetter
    • jit_attr()
    • jit_attr_ext_method()
    • jit_attr_named()
    • jit_attr_none()
    • reflective_hash()
    • static_attrgetter
    • steal_docs()
• snakeoil.osutils package
  • Submodules
    • snakeoil.osutils.mount module
      • mount()
      • umount()
    • snakeoil.osutils.native_readdir module
      • listdir_dirs()
      • listdir_files()
      • readdir()
      • stat_swallow_enoent()
  • Module contents
    • abspath()
    • abssymlink()
    • ensure_dirs()
    • join()
    • listdir()
    • listdir_dirs()
    • listdir_files()
    • normpath()
    • pjoin()
    • readdir()
    • supported_systems()
    • unlink_if_exists()
• snakeoil.process package
  • Submodules
    • snakeoil.process.namespaces module
      • create_netns()
      • create_pidns()
      • create_userns()
      • create_utsns()
      • setns()
      • simple_unshare()
      • unshare()
    • snakeoil.process.spawn module
      • bash_version()
      • cleanup_pids()
      • spawn()
      • spawn_bash()
      • spawn_get_output()
      • spawn_sandbox()
  • Module contents
    • CommandNotFound
    • ProcessNotFound
    • exit_as_status()
    • find_binary()
    • get_exit_status()

Submodules

• snakeoil.bash module
  • BashParseError
  • bash_parser
    • bash_parser.read_token()
    • bash_parser.sourcehook()
    • bash_parser.var_expand()
  • iter_read_bash()
  • read_bash()
  • read_bash_dict()
  • read_dict()
• snakeoil.caching module
  • WeakInstMeta
• snakeoil.compatibility module
  • cmp()
  • sort_cmp()
  • sorted_cmp()
• snakeoil.constraints module
  • Constraint
    • Constraint.__call__()
  • Problem
    • Problem.__iter__()
    • Problem.add_constraint()
    • Problem.add_variable()
• snakeoil.containers module
  • InvertedContains
  • LimitedChangeSet
    • LimitedChangeSet.add()
    • LimitedChangeSet.changes_count()
    • LimitedChangeSet.commit()
    • LimitedChangeSet.remove()
    • LimitedChangeSet.rollback()
  • ProtectedSet
    • ProtectedSet.add()
  • RefCountingSet
    • RefCountingSet.add()
    • RefCountingSet.discard()
    • RefCountingSet.remove()
    • RefCountingSet.update()
  • SetMixin
  • Unchangable
• snakeoil.contexts module
  • GitStash
  • Namespace
  • SplitExec
    • SplitExec.ParentException
  • chdir()
  • os_environ()
  • patch()
  • syspath()
• snakeoil.currying module
  • post_curry()
  • pre_curry()
  • pretty_docs()
• snakeoil.data_source module
  • base
    • base.bytes_fileobj()
    • base.path
    • base.text_fileobj()
    • base.transfer_to_data_source()
    • base.transfer_to_path()
    • base.weakref
  • bytes_data_source
  • bz2_source
    • bz2_source.bytes_fileobj()
    • bz2_source.mutable
    • bz2_source.path
    • bz2_source.text_fileobj()
  • data_source
    • data_source.bytes_fileobj()
    • data_source.data
    • data_source.mutable
    • data_source.text_fileobj()
  • invokable_data_source
    • invokable_data_source.bytes_fileobj()
    • invokable_data_source.text_fileobj()
    • invokable_data_source.wrap_function()
  • local_source
    • local_source.buffering_window
    • local_source.bytes_fileobj()
    • local_source.encoding
    • local_source.mutable
    • local_source.path
    • local_source.text_fileobj()
  • text_data_source
• snakeoil.decorators module
  • coroutine()
  • namespace()
  • splitexec()
• snakeoil.demandimport module
  • disable()
  • disabled()
  • enable()
  • enabled()
  • is_enabled()
• snakeoil.demandload module
  • demand_compile_regexp()
  • demandload()
• snakeoil.dependant_methods module
  • ForcedDepends
• snakeoil.deprecation module
  • deprecated
• snakeoil.errors module
  • dump_error()
  • walk_exception_chain()
• snakeoil.fileutils module
  • AtomicWriteFile
  • AtomicWriteFile_mixin
    • AtomicWriteFile_mixin.close()
    • AtomicWriteFile_mixin.discard()
  • mmap_or_open_for_read()
  • touch()
• snakeoil.formatters module
  • Formatter
    • Formatter.bg()
    • Formatter.error()
    • Formatter.fg()
    • Formatter.flush()
    • Formatter.title()
    • Formatter.warn()
    • Formatter.write()
  • PlainTextFormatter
    • PlainTextFormatter.bg()
    • PlainTextFormatter.bold
    • PlainTextFormatter.fg()
    • PlainTextFormatter.flush()
    • PlainTextFormatter.reset
    • PlainTextFormatter.underline
    • PlainTextFormatter.write()
  • decorate_forced_wrapping()
  • get_formatter()
• snakeoil.iterables module
  • caching_iter
    • caching_iter.cached_list
    • caching_iter.iterable
    • caching_iter.sorter
  • expandable_chain
    • expandable_chain.append()
    • expandable_chain.appendleft()
    • expandable_chain.extend()
    • expandable_chain.extendleft()
  • iter_sort()
  • partition()
• snakeoil.log module
  • suppress_logging()
• snakeoil.mappings module
  • AttrAccessible
  • DictMixin
    • DictMixin.clear()
    • DictMixin.get()
    • DictMixin.items()
    • DictMixin.keys()
    • DictMixin.pop()
    • DictMixin.popitem()
    • DictMixin.setdefault()
    • DictMixin.update()
    • DictMixin.values()
  • ImmutableDict
  • IndeterminantDict
    • IndeterminantDict.clear()
    • IndeterminantDict.func
    • IndeterminantDict.get()
    • IndeterminantDict.items()
    • IndeterminantDict.keys()
    • IndeterminantDict.pop()
    • IndeterminantDict.popitem()
    • IndeterminantDict.setdefault()
    • IndeterminantDict.update()
    • IndeterminantDict.values()
  • LazyFullValLoadDict
  • LazyValDict
    • LazyValDict.items()
    • LazyValDict.keys()
    • LazyValDict.values()
  • ProtectedDict
    • ProtectedDict.blacklist
    • ProtectedDict.keys()
    • ProtectedDict.new
    • ProtectedDict.orig
  • ProxiedAttrs
    • ProxiedAttrs.keys()
  • StackedDict
    • StackedDict.clear()
    • StackedDict.keys()
  • defaultdictkey
  • make_SlottedDict_kls()
• snakeoil.modules module
  • FailedImport
  • load_any()
  • load_attribute()
  • load_module()
• snakeoil.obj module
  • DelayedInstantiation()
  • DelayedInstantiation_kls()
  • make_kls()
  • popattr()
• snakeoil.pickling module
  • dump_stream()
  • iter_stream()
• snakeoil.sequences module
  • ChainedLists
    • ChainedLists.append()
    • ChainedLists.extend()
  • iflatten_func()
  • iflatten_instance()
  • iter_stable_unique()
  • predicate_split()
  • split_negations()
  • stable_unique()
  • unstable_unique()
• snakeoil.stringio module
  • bytes_readonly
    • bytes_readonly.truncate()
    • bytes_readonly.write()
    • bytes_readonly.writelines()
  • text_readonly
    • text_readonly.truncate()
    • text_readonly.write()
    • text_readonly.writelines()
• snakeoil.strings module
  • doc_dedent()
  • pluralism()
• snakeoil.struct_compat module
  • Struct
    • Struct.read()
    • Struct.write()
  • calcsize()
  • error
  • pack()
• snakeoil.tar module
  • ExFileObject
    • ExFileObject.exceptions
  • TarInfo
    • TarInfo.buf
    • TarInfo.del_buf()
    • TarInfo.del_gname()
    • TarInfo.del_uname()
    • TarInfo.get_buf()
    • TarInfo.get_gname()
    • TarInfo.get_uname()
    • TarInfo.gname
    • TarInfo.set_buf()
    • TarInfo.set_gname()
    • TarInfo.set_uname()
    • TarInfo.uname
• snakeoil.version module
  • get_git_version()
  • get_version()
• snakeoil.weakrefs module
  • WeakRefProxy
  • finalize_instance()

Module contents

snakeoil library

This library is a bit of a grabbag of the following:

• implementations that make nasty/hard problems simple in usage

• standard lib fixups; a new style UserDict base class for example that is designed around iter* overriding, rather than sequence methods as UserDict is.

• optimized implementations of common patterns