vcorelib package

Subpackages

• vcorelib.args package
  • Submodules
  • vcorelib.args.newline module
    • LineEnding
      • LineEnding.DOS
      • LineEnding.PLATFORM
      • LineEnding.UNIX
      • LineEnding.from_arg()
    • add_newline_arg()
  • Module contents
    • app_args()
• vcorelib.asyncio package
  • Submodules
  • vcorelib.asyncio.cli module
    • ProcessResult
      • ProcessResult.proc
      • ProcessResult.stderr
      • ProcessResult.stdout
    • create_subprocess_shell_log()
    • handle_process_cancel()
    • run_command()
    • run_shell()
  • vcorelib.asyncio.subprocess module
    • create_subprocess_exec_log()
    • log_process_info()
  • Module contents
    • all_stop_signals()
    • event_setter()
    • log_exceptions()
    • log_task_exception()
    • new_eloop()
    • normalize_eloop()
    • run_handle_interrupt()
    • run_handle_stop()
    • shutdown_loop()
    • try_uvloop_runner()
• vcorelib.dict package
  • Submodules
  • vcorelib.dict.cache module
    • DirectoryCache
      • DirectoryCache.context_load()
    • FileCache
      • FileCache.context_load()
    • JsonCache
      • JsonCache.context_load()
      • JsonCache.loaded()
  • vcorelib.dict.codec module
    • BasicDictCodec
      • BasicDictCodec.asdict()
      • BasicDictCodec.init()
    • DictCodec
      • DictCodec.create()
      • DictCodec.default_schemas
      • DictCodec.init()
    • JsonCodec
      • JsonCodec.asdict()
      • JsonCodec.create()
      • JsonCodec.decode()
      • JsonCodec.encode()
      • JsonCodec.file_cache()
      • JsonCodec.normalize()
  • vcorelib.dict.config module
    • Config
      • Config.from_directory()
      • Config.from_file()
      • Config.from_path()
      • Config.get()
      • Config.merge()
      • Config.set_if_not()
  • vcorelib.dict.env module
    • dict_resolve_env_vars()
    • list_resolve_env_vars()
    • str_resolve_env_var()
  • Module contents
    • MergeStrategy
      • MergeStrategy.RECURSIVE
      • MergeStrategy.UPDATE
    • consume()
    • limited()
    • merge()
    • merge_dicts()
    • merge_recursive()
    • set_if_not()
• vcorelib.graph package
  • Submodules
  • vcorelib.graph.abc module
    • AbstractDiGraph
      • AbstractDiGraph.add_edge()
      • AbstractDiGraph.add_parallel()
      • AbstractDiGraph.add_vertex()
      • AbstractDiGraph.handle_node()
      • AbstractDiGraph.is_parallel()
    • AbstractDiGraphNode
      • AbstractDiGraphNode.add_port()
      • AbstractDiGraphNode.allocate_port()
      • AbstractDiGraphNode.graph()
      • AbstractDiGraphNode.incoming()
      • AbstractDiGraphNode.join_graph()
      • AbstractDiGraphNode.label
      • AbstractDiGraphNode.outgoing()
      • AbstractDiGraphNode.parallel()
  • vcorelib.graph.edge module
    • GraphEdge
      • GraphEdge.attrs
      • GraphEdge.dst
      • GraphEdge.dst_port
      • GraphEdge.src
      • GraphEdge.src_port
      • GraphEdge.to_stream()
    • write_attributes()
    • write_node_id()
  • vcorelib.graph.node module
    • DiGraphNode
      • DiGraphNode.add_child()
      • DiGraphNode.add_parallel()
      • DiGraphNode.add_parent()
      • DiGraphNode.to_stream()
  • vcorelib.graph.port module
    • Port
      • Port.alias
      • Port.allocate()
      • Port.allocated
      • Port.is_input
      • Port.is_output
      • Port.kind
      • Port.label
    • PortManager
      • PortManager.allocate()
      • PortManager.create()
      • PortManager.inout_labels()
      • PortManager.input_labels()
      • PortManager.label()
      • PortManager.output_labels()
    • PortType
      • PortType.INOUT
      • PortType.INPUT
      • PortType.OUTPUT
      • PortType.is_input
      • PortType.is_output
  • Module contents
    • DiGraph
      • DiGraph.to_stream()
    • write_indent()
• vcorelib.io package
  • Subpackages
    • vcorelib.io.arbiter package
      • Submodules
      • vcorelib.io.arbiter.base module
      • vcorelib.io.arbiter.context module
      • vcorelib.io.arbiter.directory module
      • Module contents
    • vcorelib.io.archive package
      • Module contents
  • Submodules
  • vcorelib.io.abc module
    • FileEntity
      • FileEntity.default_location()
    • Serializable
      • Serializable.default_location()
      • Serializable.to_file()
      • Serializable.to_stream()
  • vcorelib.io.cache module
    • FlatDirectoryCache
      • FlatDirectoryCache.clean()
      • FlatDirectoryCache.load()
      • FlatDirectoryCache.load_directory()
      • FlatDirectoryCache.save()
      • FlatDirectoryCache.save_directory()
  • vcorelib.io.decode module
    • decode_ini()
    • decode_json()
    • decode_toml()
    • decode_yaml()
  • vcorelib.io.encode module
    • encode_ini()
    • encode_json()
    • encode_toml()
    • encode_yaml()
  • vcorelib.io.fifo module
    • ByteFifo
      • ByteFifo.ingest()
      • ByteFifo.pop()
  • vcorelib.io.file_writer module
    • CommentStyle
      • CommentStyle.C
      • CommentStyle.CPP
      • CommentStyle.C_DOXYGEN
      • CommentStyle.SCRIPT
      • CommentStyle.wrap()
    • IndentedFileWriter
      • IndentedFileWriter.c_comment()
      • IndentedFileWriter.cpp_comment()
      • IndentedFileWriter.dedent()
      • IndentedFileWriter.empty()
      • IndentedFileWriter.ends()
      • IndentedFileWriter.from_path()
      • IndentedFileWriter.indent()
      • IndentedFileWriter.indented()
      • IndentedFileWriter.javadoc()
      • IndentedFileWriter.join()
      • IndentedFileWriter.padding()
      • IndentedFileWriter.prefix()
      • IndentedFileWriter.scope()
      • IndentedFileWriter.string()
      • IndentedFileWriter.suffix()
      • IndentedFileWriter.temporary()
      • IndentedFileWriter.trailing_comment_lines()
      • IndentedFileWriter.write()
  • vcorelib.io.mapping module
    • DataHandle
      • DataHandle.decoder
      • DataHandle.encoder
    • DataMapping
      • DataMapping.from_ext()
      • DataMapping.from_ext_str()
      • DataMapping.mapping
    • DataType
      • DataType.INI
      • DataType.JSON
      • DataType.TOML
      • DataType.YAML
  • vcorelib.io.types module
    • FileExtension
      • FileExtension.INI
      • FileExtension.JINJA
      • FileExtension.JSON
      • FileExtension.TAR
      • FileExtension.TOML
      • FileExtension.UNKNOWN
      • FileExtension.YAML
      • FileExtension.ZIP
      • FileExtension.apply()
      • FileExtension.archive_candidates()
      • FileExtension.candidates()
      • FileExtension.data_candidates()
      • FileExtension.from_ext()
      • FileExtension.from_path()
      • FileExtension.has_archive()
      • FileExtension.is_archive()
      • FileExtension.is_data()
      • FileExtension.is_template()
    • LoadResult
      • LoadResult.data
      • LoadResult.merge()
      • LoadResult.require_success()
      • LoadResult.success
      • LoadResult.time_ns
  • Module contents
    • ByteFifo
      • ByteFifo.ingest()
      • ByteFifo.pop()
    • DataArbiter
    • FileEntity
      • FileEntity.default_location()
    • FileExtension
      • FileExtension.INI
      • FileExtension.JINJA
      • FileExtension.JSON
      • FileExtension.TAR
      • FileExtension.TOML
      • FileExtension.UNKNOWN
      • FileExtension.YAML
      • FileExtension.ZIP
      • FileExtension.apply()
      • FileExtension.archive_candidates()
      • FileExtension.candidates()
      • FileExtension.data_candidates()
      • FileExtension.from_ext()
      • FileExtension.from_path()
      • FileExtension.has_archive()
      • FileExtension.is_archive()
      • FileExtension.is_data()
      • FileExtension.is_template()
    • IndentedFileWriter
      • IndentedFileWriter.c_comment()
      • IndentedFileWriter.cpp_comment()
      • IndentedFileWriter.dedent()
      • IndentedFileWriter.empty()
      • IndentedFileWriter.ends()
      • IndentedFileWriter.from_path()
      • IndentedFileWriter.indent()
      • IndentedFileWriter.indented()
      • IndentedFileWriter.javadoc()
      • IndentedFileWriter.join()
      • IndentedFileWriter.padding()
      • IndentedFileWriter.prefix()
      • IndentedFileWriter.scope()
      • IndentedFileWriter.string()
      • IndentedFileWriter.suffix()
      • IndentedFileWriter.temporary()
      • IndentedFileWriter.trailing_comment_lines()
      • IndentedFileWriter.write()
    • LoadResult
      • LoadResult.data
      • LoadResult.merge()
      • LoadResult.require_success()
      • LoadResult.success
      • LoadResult.time_ns
    • Serializable
      • Serializable.default_location()
      • Serializable.to_file()
      • Serializable.to_stream()
• vcorelib.logging package
  • Submodules
  • vcorelib.logging.args module
    • forward_flags()
    • forward_logging_flags()
    • init_logging()
    • logging_args()
  • vcorelib.logging.time module
    • log_time()
  • Module contents
    • LoggerMixin
      • LoggerMixin.log_time()
      • LoggerMixin.logger
    • forward_flags()
    • forward_logging_flags()
    • init_logging()
    • log_time()
    • logging_args()
    • normalize()
• vcorelib.math package
  • Subpackages
    • vcorelib.math.analysis package
      • Subpackages
      • Submodules
      • vcorelib.math.analysis.average module
      • vcorelib.math.analysis.buffer module
      • vcorelib.math.analysis.weighted module
      • Module contents
  • Submodules
  • vcorelib.math.constants module
    • from_nanos()
    • to_nanos()
  • vcorelib.math.time module
    • Timer
      • Timer.log()
      • Timer.measure_ns()
      • Timer.result()
    • byte_count_str()
    • default_time_ns()
    • nano_str()
    • rate_str()
    • seconds_str()
  • vcorelib.math.unit module
    • UnitSystem
      • UnitSystem.divisor
      • UnitSystem.prefixes
    • unit_traverse()
  • Module contents
    • FloatBuffer
      • FloatBuffer.reset()
      • FloatBuffer.resize()
    • MovingAverage
      • MovingAverage.reset()
      • MovingAverage.resize()
    • MovingSum
      • MovingSum.reset()
    • RateLimiter
      • RateLimiter.rate_hz
    • RateTracker
      • RateTracker.measure()
      • RateTracker.poll()
      • RateTracker.reset()
      • RateTracker.value
      • RateTracker.with_dt()
    • Timer
      • Timer.log()
      • Timer.measure_ns()
      • Timer.result()
    • UnitSystem
      • UnitSystem.divisor
      • UnitSystem.prefixes
    • WeightedAverage
      • WeightedAverage.average()
      • WeightedAverage.depth
      • WeightedAverage.reset()
    • byte_count_str()
    • default_time_ns()
    • from_nanos()
    • nano_str()
    • rate_str()
    • seconds_str()
    • to_nanos()
    • unit_traverse()
• vcorelib.namespace package
  • Submodules
  • vcorelib.namespace.base module
    • Namespace
      • Namespace.child()
      • Namespace.length_sorted_suggestions()
      • Namespace.namespace()
      • Namespace.parents
      • Namespace.pop()
      • Namespace.push()
      • Namespace.pushed()
      • Namespace.search()
      • Namespace.suggest()
      • Namespace.suggestions()
  • vcorelib.namespace.mixin module
    • NamespaceMixin
      • NamespaceMixin.child_namespace()
      • NamespaceMixin.names_pushed()
      • NamespaceMixin.namespace()
      • NamespaceMixin.namespace_search()
      • NamespaceMixin.namespace_suggest()
      • NamespaceMixin.ns
      • NamespaceMixin.pop_name()
      • NamespaceMixin.push_name()
  • Module contents
    • Namespace
      • Namespace.child()
      • Namespace.length_sorted_suggestions()
      • Namespace.namespace()
      • Namespace.parents
      • Namespace.pop()
      • Namespace.push()
      • Namespace.pushed()
      • Namespace.search()
      • Namespace.suggest()
      • Namespace.suggestions()
    • NamespaceMixin
      • NamespaceMixin.child_namespace()
      • NamespaceMixin.names_pushed()
      • NamespaceMixin.namespace()
      • NamespaceMixin.namespace_search()
      • NamespaceMixin.namespace_suggest()
      • NamespaceMixin.ns
      • NamespaceMixin.pop_name()
      • NamespaceMixin.push_name()
• vcorelib.paths package
  • Submodules
  • vcorelib.paths.base module
    • get_file_ext()
    • get_file_name()
    • normalize()
    • rel()
    • set_exec_flags()
    • stats()
  • vcorelib.paths.context module
    • in_dir()
    • linked_to()
    • tempfile()
  • vcorelib.paths.find module
    • find_file()
    • find_package_file()
    • register_file_finder()
  • vcorelib.paths.hashing module
    • bytes_hash_hex()
    • bytes_md5_hex()
    • create_hex_digest()
    • file_hash_hex()
    • file_md5_hex()
    • str_hash_hex()
    • str_md5_hex()
    • validate_hex_digest()
  • vcorelib.paths.info module
    • FileChangeEvent
      • FileChangeEvent.CREATED
      • FileChangeEvent.REMOVED
      • FileChangeEvent.UPDATED
    • FileInfo
      • FileInfo.from_file()
      • FileInfo.from_json()
      • FileInfo.md5_hex
      • FileInfo.modified_ns
      • FileInfo.path
      • FileInfo.poll()
      • FileInfo.same()
      • FileInfo.size
      • FileInfo.to_json()
  • vcorelib.paths.info_cache module
    • FileChangeEvent
      • FileChangeEvent.CREATED
      • FileChangeEvent.REMOVED
      • FileChangeEvent.UPDATED
    • FileChanged
      • FileChanged.event
      • FileChanged.new
      • FileChanged.old
    • FileInfo
      • FileInfo.from_file()
      • FileInfo.from_json()
      • FileInfo.md5_hex
      • FileInfo.modified_ns
      • FileInfo.path
      • FileInfo.poll()
      • FileInfo.same()
      • FileInfo.size
      • FileInfo.to_json()
    • FileInfoManager
      • FileInfoManager.poll_directory()
      • FileInfoManager.poll_existing()
      • FileInfoManager.poll_file()
    • file_info_cache()
  • Module contents
    • bytes_hash_hex()
    • bytes_md5_hex()
    • create_hex_digest()
    • file_hash_hex()
    • file_md5_hex()
    • find_file()
    • get_file_ext()
    • get_file_name()
    • modified_after()
    • modified_ns()
    • normalize()
    • rel()
    • resource()
    • set_exec_flags()
    • stats()
    • str_hash_hex()
    • str_md5_hex()
    • validate_hex_digest()
• vcorelib.platform package
  • Module contents
    • is_windows()
    • reconcile_platform()
• vcorelib.schemas package
  • Submodules
  • vcorelib.schemas.base module
    • Schema
      • Schema.from_path()
    • SchemaMap
      • SchemaMap.from_package()
      • SchemaMap.kind()
      • SchemaMap.load_directory()
      • SchemaMap.load_file()
      • SchemaMap.load_package()
    • SchemaValidationError
  • vcorelib.schemas.json module
    • JsonSchema
    • JsonSchemaMap
      • JsonSchemaMap.kind()
    • package_handler()
  • vcorelib.schemas.mixins module
    • SchemaMixin
      • SchemaMixin.schema
      • SchemaMixin.schema_name()
      • SchemaMixin.validate()
  • Module contents
    • CerberusSchema
    • CerberusSchemaMap
      • CerberusSchemaMap.kind()
• vcorelib.script package
  • Module contents
    • ScriptableMixin
      • ScriptableMixin.invoked()
      • ScriptableMixin.script()
    • invoke_script()
• vcorelib.target package
  • Submodules
  • vcorelib.target.evaluation module
    • DynamicTargetEvaluator
      • DynamicTargetEvaluator.compile_key()
    • TargetEvaluatorInterface
      • TargetEvaluatorInterface.compile()
      • TargetEvaluatorInterface.compile_key()
    • TargetInterface
      • TargetInterface.compile()
      • TargetInterface.dynamic_end
      • TargetInterface.dynamic_start
      • TargetInterface.is_literal()
      • TargetInterface.parse()
      • TargetInterface.segment_count()
  • vcorelib.target.expression module
    • ExpressionTarget
      • ExpressionTarget.compile_match()
      • ExpressionTarget.parse()
    • ExpressionTargetEvaluator
      • ExpressionTargetEvaluator.compile_key()
  • vcorelib.target.resolver module
    • TargetResolution
      • TargetResolution.data
      • TargetResolution.result
    • TargetResolver
      • TargetResolver.evaluate()
      • TargetResolver.evaluate_all()
      • TargetResolver.register()
  • Module contents
    • Target
      • Target.evaluate()
      • Target.parse()
      • Target.valid
    • TargetMatch
      • TargetMatch.get()
      • TargetMatch.matched
      • TargetMatch.substitutions
• vcorelib.task package
  • Subpackages
    • vcorelib.task.dict package
      • Submodules
      • vcorelib.task.dict.melder module
      • Module contents
    • vcorelib.task.subprocess package
      • Submodules
      • vcorelib.task.subprocess.run module
      • Module contents
    • vcorelib.task.time package
      • Submodules
      • vcorelib.task.time.sleep module
      • Module contents
  • Submodules
  • vcorelib.task.manager module
    • TaskManager
      • TaskManager.evaluate()
      • TaskManager.execute()
      • TaskManager.finalize()
      • TaskManager.prepare_execute()
      • TaskManager.register()
      • TaskManager.register_to()
  • Module contents
    • FailTask
      • FailTask.run()
    • Phony
      • Phony.run()
    • Task
      • Task.create_execute()
      • Task.default_requirements
      • Task.depend_on()
      • Task.depend_on_all()
      • Task.dispatch()
      • Task.dispatch_init()
      • Task.resolve()
      • Task.resolve_dependencies()
      • Task.resolved()
      • Task.run()
      • Task.run_enter()
      • Task.run_exit()
      • Task.stack
      • Task.stages
      • Task.task_fail()
    • TaskFailed

Submodules

vcorelib.names module

Common name manipulations.

vcorelib.names.obj_class_to_snake(class_obj: Any) → str

Convert a CamelCase named class to a snake_case String.

vcorelib.names.to_snake(name: str, lower_dashes: bool = True) → str

Convert a CamelCase String to snake_case.

vcorelib.python module

A module for working with paths to python interpreters and virtual environments.

vcorelib.python.python_entry(version: str = None) → str

Attempt to get a Python entry-point as a string.

vcorelib.python.python_version() → str

Get the version of Python to use.

vcorelib.python.venv_bin(cwd: Path | str | None, program: str = None, version: str = None) → Path

Get the path to a virtual environment’s script directory.

vcorelib.python.venv_dir(cwd: Path | str | None, version: str = None) → Path

Get the path for a virtual environment to use.

vcorelib.python.venv_name(version: str = None) → str

Get the name for a virtual environment to use.

Module contents

Useful defaults and other package metadata.