synced_collections

https://synced-collections.readthedocs.io/en/latest/
Admin
synced_collections is a Python library for managing synchronized collections (lists, dicts) with...
Tokens:1,888
Snippets:19
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### SyncedDict Methods

Source: https://synced-collections.readthedocs.io/en/latest

Methods available for the SyncedDict class.

```APIDOC
## SyncedDict.clear()

### Description
Clears all items from the SyncedDict.

### Method
clear

### Endpoint
N/A (Python method)

## SyncedDict.get()

### Description
Retrieves an item from the SyncedDict by key.

### Method
get

### Endpoint
N/A (Python method)

## SyncedDict.is_base_type()

### Description
Checks if the SyncedDict is a base type.

### Method
is_base_type

### Endpoint
N/A (Python method)

## SyncedDict.items()

### Description
Returns a view object that displays a list of a dictionary's key-value tuple pairs.

### Method
items

### Endpoint
N/A (Python method)

## SyncedDict.keys()

### Description
Returns a view object that displays a list of all the keys in the dictionary.

### Method
keys

### Endpoint
N/A (Python method)

## SyncedDict.pop()

### Description
Removes the specified key and returns the corresponding value.

### Method
pop

### Endpoint
N/A (Python method)

## SyncedDict.popitem()

### Description
Removes and returns an arbitrary (key, value) pair from the dictionary.

### Method
popitem

### Endpoint
N/A (Python method)

## SyncedDict.reset()

### Description
Resets the SyncedDict to its initial state.

### Method
reset

### Endpoint
N/A (Python method)

## SyncedDict.setdefault()

### Description
Returns the value of the key if key is in the dictionary, else a default value.

### Method
setdefault

### Endpoint
N/A (Python method)

## SyncedDict.update()

### Description
Updates the dictionary with the key-value pairs from other, overwriting existing keys.

### Method
update

### Endpoint
N/A (Python method)

## SyncedDict.values()

### Description
Returns a view object that displays a list of all the values in the dictionary.

### Method
values

### Endpoint
N/A (Python method)
```

--------------------------------

### SyncedList Methods

Source: https://synced-collections.readthedocs.io/en/latest

Methods available for the SyncedList class.

```APIDOC
## SyncedList.append()

### Description
Appends an item to the end of the SyncedList.

### Method
append

### Endpoint
N/A (Python method)

## SyncedList.clear()

### Description
Removes all items from the SyncedList.

### Method
clear

### Endpoint
N/A (Python method)

## SyncedList.extend()

### Description
Extends the SyncedList by appending all the items from an iterable.

### Method
extend

### Endpoint
N/A (Python method)

## SyncedList.insert()

### Description
Inserts an item at a given position in the SyncedList.

### Method
insert

### Endpoint
N/A (Python method)

## SyncedList.is_base_type()

### Description
Checks if the SyncedList is a base type.

### Method
is_base_type

### Endpoint
N/A (Python method)

## SyncedList.remove()

### Description
Removes the first occurrence of a value from the SyncedList.

### Method
remove

### Endpoint
N/A (Python method)

## SyncedList.reset()

### Description
Resets the SyncedList to its initial state.

### Method
reset

### Endpoint
N/A (Python method)
```

--------------------------------

### BufferedCollection Methods

Source: https://synced-collections.readthedocs.io/en/latest

Methods available for the BufferedCollection class.

```APIDOC
## BufferedCollection.backend_is_buffered()

### Description
Checks if the backend of the BufferedCollection is buffered.

### Method
backend_is_buffered

### Endpoint
N/A (Python method)

## BufferedCollection.buffer_backend()

### Description
Buffers the backend of the BufferedCollection.

### Method
buffer_backend

### Endpoint
N/A (Python method)
```

--------------------------------

### FileBufferedCollection Methods

Source: https://synced-collections.readthedocs.io/en/latest

Methods available for the FileBufferedCollection class.

```APIDOC
## FileBufferedCollection.buffer_backend()

### Description
Buffers the backend of the FileBufferedCollection.

### Method
buffer_backend

### Endpoint
N/A (Python method)

## FileBufferedCollection.disable_multithreading()

### Description
Disables multithreading for the FileBufferedCollection.

### Method
disable_multithreading

### Endpoint
N/A (Python method)

## FileBufferedCollection.enable_multithreading()

### Description
Enables multithreading for the FileBufferedCollection.

### Method
enable_multithreading

### Endpoint
N/A (Python method)

## FileBufferedCollection.get_buffer_capacity()

### Description
Retrieves the buffer capacity of the FileBufferedCollection.

### Method
get_buffer_capacity

### Endpoint
N/A (Python method)

## FileBufferedCollection.get_current_buffer_size()

### Description
Retrieves the current buffer size of the FileBufferedCollection.

### Method
get_current_buffer_size

### Endpoint
N/A (Python method)

## FileBufferedCollection.set_buffer_capacity()

### Description
Sets the buffer capacity for the FileBufferedCollection.

### Method
set_buffer_capacity

### Endpoint
N/A (Python method)
```

--------------------------------

### SyncedCollection Methods

Source: https://synced-collections.readthedocs.io/en/latest

Methods available for the SyncedCollection class.

```APIDOC
## SyncedCollection.__call__()

### Description
This method is part of the SyncedCollection class.

### Method
__call__

### Endpoint
N/A (Python method)

## SyncedCollection.disable_multithreading()

### Description
Disables multithreading for the SyncedCollection.

### Method
disable_multithreading

### Endpoint
N/A (Python method)

## SyncedCollection.enable_multithreading()

### Description
Enables multithreading for the SyncedCollection.

### Method
enable_multithreading

### Endpoint
N/A (Python method)

## SyncedCollection.is_base_type()

### Description
Checks if the SyncedCollection is a base type.

### Method
is_base_type

### Endpoint
N/A (Python method)

## SyncedCollection.registry

### Description
Accesses the registry for the SyncedCollection.

### Method
registry

### Endpoint
N/A (Python attribute)
```

--------------------------------

### MongoDBCollection Attributes

Source: https://synced-collections.readthedocs.io/en/latest

Attributes available for the MongoDBCollection class.

```APIDOC
## MongoDBCollection.collection

### Description
Represents the MongoDB collection object.

### Method
collection

### Endpoint
N/A (Python attribute)

## MongoDBCollection.uid

### Description
Represents the unique identifier for the MongoDBCollection.

### Method
uid

### Endpoint
N/A (Python attribute)
```

--------------------------------

### ZarrCollection Attributes

Source: https://synced-collections.readthedocs.io/en/latest

Attributes available for the ZarrCollection class.

```APIDOC
## ZarrCollection.codec

### Description
Represents the codec used for the ZarrCollection.

### Method
codec

### Endpoint
N/A (Python attribute)

## ZarrCollection.group

### Description
Represents the Zarr group associated with the ZarrCollection.

### Method
group

### Endpoint
N/A (Python attribute)

## ZarrCollection.name

### Description
Represents the name of the ZarrCollection.

### Method
name

### Endpoint
N/A (Python attribute)
```

--------------------------------

### JSONCollection Attributes

Source: https://synced-collections.readthedocs.io/en/latest

Attributes available for the JSONCollection class.

```APIDOC
## JSONCollection.filename

### Description
Represents the filename associated with the JSONCollection.

### Method
filename

### Endpoint
N/A (Python attribute)
```

--------------------------------

### RedisCollection Attributes

Source: https://synced-collections.readthedocs.io/en/latest

Attributes available for the RedisCollection class.

```APIDOC
## RedisCollection.client

### Description
Represents the Redis client instance.

### Method
client

### Endpoint
N/A (Python attribute)

## RedisCollection.key

### Description
Represents the key used in Redis for the RedisCollection.

### Method
key

### Endpoint
N/A (Python attribute)
```
Tokens:
Raw