zentetsu / sharedmemory Goto Github PK

View Code? Open in Web Editor NEW

11.0 2.0 2.0 154 KB

Python shared memory library based an posix-ipc.

License: GNU General Public License v3.0

Python 100.00%

sharedmemory python

sharedmemory's Introduction

SharedMemory

Python shared memory library based an posix-ipc.

Features

Shared type:
- Basic type (int, float, bool, str)
- list, tuple, dict and nparray
Management of the availability of shared memory space
Overloaded methods for list and dict (basic)
Methods to manage all defined shared space
Space Memory configurable
Semaphore

Installation

$> pip install SharedMemory

Example

Example of execution in two instances of ipython.

Client side

In [1]: from SharedMemory import SharedMemory

In [2]: # Creating client instance with a shared space named 'shared_space' with a size of 10
   ...: C = SharedMemory(name="shared_space", value="Hello", client=True)

In [4]: C.getAvailability()
Out[4]: True

In [5]: C.getValue()
Out[5]: 'Hello'

In [6]: # Waiting for Server to update shared data

In [7]: C.getValue()
Out[7]: 'World'

In [8]: C.setValue('HW')
Out[8]: True

In [9]: C.getValue()
Out[9]: 'HW'

In [10]: # Closing the client side
    ...: C.close()

In [11]: C.getAvailability()
Out[11]: False

Server side

In [1]: from SharedMemory import SharedMemory

In [2]: # Creating server instance access to the shared named 'shared_space'
   ...: S = SharedMemory(name="shared_space", client=False)

In [4]: S.getAvailability()
Out[4]: True

In [5]: S.getValue()
Out[5]: 'Hello'

In [6]: S.setValue("World")
Out[6]: True

In [7]: S.getValue()
Out[7]: 'Hello'

In [8]: # Waiting for Client to update shared data

In [9]: S.getValue()
Out[9]: 'HW'

In [10]: # Waiting Client to close the shared space

In [11]: S.getAvailability()
Out[11]: False


In [12]: # Closing the server side
    ...: S.close()
INFO: Client already stopped.

sharedmemory's People

Contributors

Stargazers

Watchers

Forkers

inselbuch jinyistudio534

sharedmemory's Issues

Dear author, hello! I tried your tool and it works very well. But I need it more in the field of deep learning. I don't know if you can add numpy-compatible functions. I would be very grateful!

Is your enhancement proposal related to a problem? Please describe.
A clear and concise description of what the problem is.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or graphics (drag-and-drop an image) about the feature request here.

Avoid crashing on successive calls of start or stop methods

Is your enhancement proposal related to a problem? Please describe.
When calling the stop or start methods for the client and the stop method for the server successively, this causes the script to crash.

Describe the solution you'd like
When these methods are called successively, the solution would be to simply inform the user that the system is already stopped or started.

A function to provide full list of shared memory blocks

Just like SharedArray for python3.6 there should be a function list() which return list of arrays created, can we add that funcitonality, i want to use that feature in my project

Question:

The readme says:

Encapsulation of the python shared_memory library.

What is shared_memory? Is that referring to the multiprocessing moudle or something else?

Is it a port of Python3.8 SharedMemory to use with earlier versions of python?

Are there any example code you can put in the readme on how to use your SharedMemory?

Finish Shared Memory API

Add numpy support

[BUG] Documentation has parameter "exist" which was removed.

The sample code has this, but it is no longer valid.

,exists=False)

Expected Behavior

Sample code should be correct and accurate.

Current Behavior

TypeError: SharedMemory.__init__() got an unexpected keyword argument 'exists'

Possible Solution

Steps to Reproduce

Try to run your example.

Context (Environment)

Detailed Description

Possible Implementation

Does shared memory block gets killed in shared_memory after the python process is complete

Even if we don't delete the shared memory block using python, does it get automatically killed after the python process is run?

Server availability is not updated

Is your enhancement proposal related to a problem? Please describe.
When calling the getAvailability method of the client just after the server is started, the availability of the server is always set to False.

Describe the solution you'd like
When this method is called, the solution would be to simply call the _checkServerAvailability before returning the availability status.