Skip to content

Commit a36fbeb

Browse files
committed
doc(readme): make limitations way more prominent
Also inform about the likelyhood of leaking system resources. [skip ci]
1 parent 6e55a1c commit a36fbeb

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ When reading from many possibly large files in a fashion similar to random acces
55
Although memory maps have many advantages, they represent a very limited system resource as every map uses one file descriptor, whose amount is limited per process. On 32 bit systems, the amount of memory you can have mapped at a time is naturally limited to theoretical 4GB of memory, which may not be enough for some applications.
66

77

8+
## Limitations
9+
10+
* **System resources (file-handles) are likely to be leaked!** This is due to the library authors reliance on a deterministic `__del__()` destructor.
11+
* The memory access is read-only by design.
12+
* In python below 2.6, memory maps will be created in compatibility mode which works, but creates inefficient memory mappings as they always start at offset 0.
13+
814

915
## Overview
1016

@@ -33,11 +39,6 @@ For performance critical 64 bit applications, a simplified version of memory map
3339

3440
The package was tested on all of the previously mentioned configurations.
3541

36-
## Limitations
37-
38-
* The memory access is read-only by design.
39-
* In python below 2.6, memory maps will be created in compatibility mode which works, but creates inefficient memory mappings as they always start at offset 0.
40-
4142
## Installing smmap
4243

4344
[![Documentation Status](https://readthedocs.org/projects/smmap/badge/?version=latest)](https://readthedocs.org/projects/smmap/?badge=latest)

0 commit comments

Comments
 (0)