:py:mod:`dissect.target.tools.utils.fs`
=======================================

.. py:module:: dissect.target.tools.utils.fs




Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.tools.utils.fs.prepare_ls_colors
   dissect.target.tools.utils.fs.fmt_ls_colors
   dissect.target.tools.utils.fs.human_size
   dissect.target.tools.utils.fs.stat_modestr
   dissect.target.tools.utils.fs.print_extensive_file_stat_listing
   dissect.target.tools.utils.fs.ls_scandir
   dissect.target.tools.utils.fs.print_ls
   dissect.target.tools.utils.fs.print_stat
   dissect.target.tools.utils.fs.print_xattr



Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.tools.utils.fs.STAT_TEMPLATE
   dissect.target.tools.utils.fs.FALLBACK_LS_COLORS
   dissect.target.tools.utils.fs.LS_COLORS


.. py:data:: STAT_TEMPLATE
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """  File: {path} {symlink}
        Size: {size}       Blocks: {blocks}    IO Block: {blksize}     {filetype}
      Device: {device}     Inode: {inode}      Links: {nlink}
      Access: ({modeord}/{modestr})  Uid: ( {uid} )   Gid: ( {gid} )
      Access: {atime}
      Modify: {mtime}
      Change: {ctime}
       Birth: {btime}"""

   .. raw:: html

      </details>



.. py:data:: FALLBACK_LS_COLORS
   :value: 'rs=0:di=01;34:ln=01;36:mh=00:pi=40;33:so=01;35:do=01;35:bd=40;33;01:cd=40;33;01:or=40;31;01:mi=0...


.. py:function:: prepare_ls_colors() -> dict[str, str]

   Parse the LS_COLORS environment variable so we can use it later.


.. py:data:: LS_COLORS

.. py:function:: fmt_ls_colors(ft: str, name: str) -> str

   Helper method to colorize strings according to LS_COLORS.


.. py:function:: human_size(bytes: int, units: collections.abc.Sequence[str] = ('', 'K', 'M', 'G', 'T', 'P', 'E')) -> str

   Helper function to return the human readable string representation of bytes.


.. py:function:: stat_modestr(st: dissect.target.helpers.fsutil.stat_result) -> str

   Helper method for generating a mode string from a numerical mode value.


.. py:function:: print_extensive_file_stat_listing(stdout: TextIO, name: str, entry: dissect.target.filesystem.FilesystemEntry | None = None, timestamp: datetime.datetime | None = None, human_readable: bool = False) -> None

   Print the file status as a single line.


.. py:function:: ls_scandir(path: dissect.target.helpers.fsutil.TargetPath, color: bool = False) -> list[tuple[dissect.target.helpers.fsutil.TargetPath, str]]

   List a directory for the given path.


.. py:function:: print_ls(path: dissect.target.helpers.fsutil.TargetPath, depth: int, stdout: TextIO, long_listing: bool = False, human_readable: bool = False, recursive: bool = False, use_ctime: bool = False, use_atime: bool = False, color: bool = True) -> None

   Print ls output.


.. py:function:: print_stat(path: dissect.target.helpers.fsutil.TargetPath, stdout: TextIO, dereference: bool = False) -> None

   Print file status.


.. py:function:: print_xattr(basename: str, xattr: list, stdout: TextIO) -> None

   Mimics getfattr -d {file} behaviour.