# zpp_ManagedFile
## Informations
Système de fichier managé pour le contrôle des actions sur un fichier tels que la fermeture du fichier.
Permet de créer plusieurs types de fichier:
- file: Ouverture d'un fichier présent sur le système
- string: Simulation d'un fichier
- bytesio: Fichier bytes en mémoire
- stringio: Fichier en mémoire
- tempfile: Fichier temporaire
<br>
## Installation
```console
pip install zpp_ManagedFile
```
<br>
## Utilisation
```python
file = zpp_ManagedFile.ManagedFile()
```
filename=None, mode='r', typefile="stringio", encoding=None, closable=True
>En paramètre supplémentaire, nous pouvons mettre:<br/>
>- filename = Chemin du fichier si typefile=file
>- mode = Option sur le fichier (w/r/a) (default: r)
>- typefile = type de fichier (file,string,bytesio,stringio,tempfile) (default: stringio)
>- encoding = type d'encodage du fichier
>- closable = activer le blocage de la fermeture (True pour activer)
Le fichier a les mêmes actions q'un fichier classique.
### Bloquer la fermeture du fichier
Il est possible de bloquer la fermeture du fichier en utlisant la méthode isClosable
```python
file.isClosable(True)
```
<br>
## Opération courantes sur les fichiers
### Fermeture du fichier
```python
file.close()
```
### Ecriture dans un fichier
```python
file.write(data)
```
### Ecriture d'une liste dans un fichier
```python
file.writelines(list)
```
### Flush des données du buffer
```python
file.flush()
```
### Tronquer le fichier
```python
file.truncate(size)
```
size détermine la taille du fichier tronqué
### Lecture d'un fichier
```python
file.read(size)
```
Si size est déterminé, lis seulement x bytes du fichier
### Lecture d'une ligne d'un fichier
```python
file.readline(size)
```
Si size est déterminé, lis seulement x bytes du fichier
### Récupération du contenu du fichier sous forme de liste
```python
file.readlines()
```
### Déplacer le curseur
```python
file.seek(offset, [mode])
```
offset correspond au déplacement
mode (optionnel) correspond à l'option de déplacement (0: déplacement depuis le début du fichier, 1: déplacement depuis la position actuelle, 2: déplacement depuis la fin du fichier)
### Connaitre la position du curseur
```python
file.tell()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ZephyrOff/py-zpp_ManagedFile",
"name": "zpp-ManagedFile",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "file zephyroff",
"author": "ZephyrOff",
"author_email": "contact@apajak.fr",
"download_url": "https://files.pythonhosted.org/packages/ea/3f/144bc680d479797e366b8942d12aeee8245cbbf9f4f0e0161a136b8137f8/zpp_ManagedFile-1.0.1.tar.gz",
"platform": "ALL",
"description": "# zpp_ManagedFile\n## Informations\nSyst\u00e8me de fichier manag\u00e9 pour le contr\u00f4le des actions sur un fichier tels que la fermeture du fichier.\nPermet de cr\u00e9er plusieurs types de fichier:\n- file: Ouverture d'un fichier pr\u00e9sent sur le syst\u00e8me\n- string: Simulation d'un fichier\n- bytesio: Fichier bytes en m\u00e9moire\n- stringio: Fichier en m\u00e9moire\n- tempfile: Fichier temporaire\n\n<br>\n\n## Installation\n```console\npip install zpp_ManagedFile\n```\n<br>\n\n## Utilisation\n```python\nfile = zpp_ManagedFile.ManagedFile()\n```\nfilename=None, mode='r', typefile=\"stringio\", encoding=None, closable=True\n>En param\u00e8tre suppl\u00e9mentaire, nous pouvons mettre:<br/>\n>- filename = Chemin du fichier si typefile=file\n>- mode = Option sur le fichier (w/r/a) (default: r)\n>- typefile = type de fichier (file,string,bytesio,stringio,tempfile) (default: stringio)\n>- encoding = type d'encodage du fichier\n>- closable = activer le blocage de la fermeture (True pour activer)\n\nLe fichier a les m\u00eames actions q'un fichier classique.\n\n### Bloquer la fermeture du fichier\n\nIl est possible de bloquer la fermeture du fichier en utlisant la m\u00e9thode isClosable\n```python\nfile.isClosable(True)\n```\n<br>\n\n## Op\u00e9ration courantes sur les fichiers\n\n### Fermeture du fichier\n```python\nfile.close()\n```\n\n### Ecriture dans un fichier\n```python\nfile.write(data)\n```\n\n### Ecriture d'une liste dans un fichier\n```python\nfile.writelines(list)\n```\n\n### Flush des donn\u00e9es du buffer\n```python\nfile.flush()\n```\n\n### Tronquer le fichier\n```python\nfile.truncate(size)\n```\nsize d\u00e9termine la taille du fichier tronqu\u00e9\n\n### Lecture d'un fichier\n```python\nfile.read(size)\n```\nSi size est d\u00e9termin\u00e9, lis seulement x bytes du fichier\n\n### Lecture d'une ligne d'un fichier\n```python\nfile.readline(size)\n```\nSi size est d\u00e9termin\u00e9, lis seulement x bytes du fichier\n\n### R\u00e9cup\u00e9ration du contenu du fichier sous forme de liste\n```python\nfile.readlines()\n```\n\n### D\u00e9placer le curseur\n```python\nfile.seek(offset, [mode])\n```\noffset correspond au d\u00e9placement\nmode (optionnel) correspond \u00e0 l'option de d\u00e9placement (0: d\u00e9placement depuis le d\u00e9but du fichier, 1: d\u00e9placement depuis la position actuelle, 2: d\u00e9placement depuis la fin du fichier)\n\n### Connaitre la position du curseur\n```python\nfile.tell()\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Syst\u00e8me de fichier manag\u00e9 pour le contr\u00f4le des actions sur un fichier",
"version": "1.0.1",
"split_keywords": [
"file",
"zephyroff"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "76d954eb2db75dddf9e3fbd775415e5c",
"sha256": "6fa57336bae13633ba599e47625bfe92191cd148dfc45b7d44554510ab7d3256"
},
"downloads": -1,
"filename": "zpp_ManagedFile-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "76d954eb2db75dddf9e3fbd775415e5c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4509,
"upload_time": "2022-12-16T09:58:51",
"upload_time_iso_8601": "2022-12-16T09:58:51.176388Z",
"url": "https://files.pythonhosted.org/packages/bb/51/d87d81a5f260265cf3a65f8ba9a1cdc6e32ec87161bfb7389bc812e40145/zpp_ManagedFile-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "a7560b3d1117695d00d2aad7e13d2150",
"sha256": "e03d1aec7eafcbef51fde1766359a7393e262a5f72810f4e65086f31994aff5c"
},
"downloads": -1,
"filename": "zpp_ManagedFile-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a7560b3d1117695d00d2aad7e13d2150",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4188,
"upload_time": "2022-12-16T09:58:53",
"upload_time_iso_8601": "2022-12-16T09:58:53.168693Z",
"url": "https://files.pythonhosted.org/packages/ea/3f/144bc680d479797e366b8942d12aeee8245cbbf9f4f0e0161a136b8137f8/zpp_ManagedFile-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-16 09:58:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ZephyrOff",
"github_project": "py-zpp_ManagedFile",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "zpp-managedfile"
}
JSON
