Skip to main content

Ctrl+K

barecat

Getting Started
Working with Image Datasets
How to Automatically Encode and Decode Files
How to Convert Archives
How to Merge Archives

GitHub

Getting Started
Working with Image Datasets
How to Automatically Encode and Decode Files
How to Convert Archives
How to Merge Archives
How to Use with PyTorch DataLoader
How to Mount with FUSE
How to Set Up Shell Completions
How to Verify and Repair Archives
Command Line Interface
Python API Reference
File Format Specification
Architecture
Integrity Checking
Comparison with Other Formats
Performance Characteristics

GitHub

Section Navigation

barecat.__main__
barecat.exceptions
barecat.io
- barecat.io.copyfile
- barecat.io.fileobj
  - BarecatFileObjectHelper
    
    open
  - BarecatFileObject
  - BarecatReadOnlyFileObject
    
    read
    
    readinto
    
    readall
    
    readable
    
    seekable
    
    sendfile
    
    writable
    
    truncate
    
    readline
    
    tell
    
    seek
    
    close
    
    size
  - BarecatReadWriteFileObject
    
    tell
    
    seek
    
    truncate
    
    readable
    
    writable
    
    seekable
    
    flush
    
    close
  - accumulate_crc32c
  - write_zeroes
- barecat.io.open
  - open
  - reopen
- copy
- copy_crc32c
- accumulate_crc32c
- write_zeroes

Barecat
- __getitem__
- get
- items
- keys
- values
- __contains__
- __len__
- __iter__
- __setitem__
- setdefault
- __delitem__
- open
- exists
- isfile
- isdir
- listdir
- walk
- scandir
- glob
- globfiles
- iglob
- iglobfiles
- files
- dirs
- num_files
- num_dirs
- total_size
- readinto
- read
- add_by_path
- add
- update_file
- mkdir
- remove
- rmdir
- rmtree
- rename
- total_physical_size_seek
- total_physical_size_stat
- total_logical_size
- merge_from_other_barecat
- shard_size_limit
- logical_shard_end
- physical_shard_end
- index
- check_crc32c
- verify_integrity
- register_codec
- defrag
- close
- __exit__
Index
Sharder
- __exit__
BarecatDirInfo
BarecatEntryInfo
- mode
- uid
- gid
- mtime_ns
- path
- mtime_dt
- isfile
- isdir
- update_mtime
- fill_from_statresult
- row_factory
BarecatFileInfo
- shard
- offset
- size
- crc32c
- asdict
- fill_from_statresult
- end
- isfile
Order
- ANY
- RANDOM
- ADDRESS
- PATH
- DESC
- as_query_text
BarecatFileObject
BarecatReadOnlyFileObject
- read
- readinto
- readall
- readable
- seekable
- sendfile
- writable
- truncate
- readline
- tell
- seek
- close
- size
BarecatReadWriteFileObject
- tell
- seek
- truncate
- readable
- writable
- seekable
- flush
- close
DecodedView
- register_codec
- clear_codecs
- keys
- items
- values

get_completion_script
get_cached_reader
open

BarecatFileObject

BarecatFileObject#

class barecat.io.fileobj.BarecatFileObject[source]#

Bases: io.IOBase

Base class for Barecat file-like objects.

© Copyright 2026, István Sárándi.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.