Aller au contenu

FTP

FTP

Python
FTP(host, port=22)

Client SFTP minimal basé sur paramiko.

Fournit des opérations simples: connexion, changement de dossier, listage, upload, download et fermeture.

Initialise la connexion SFTP (sans authentification).

Parameters:

Name Type Description Default
host str

Nom d'hôte ou IP du serveur SFTP.

 required
port int

Port SFTP (par défaut: 22).

 22
Source code in cmpparis/ftp.py
Python
13
14
15
16
17
18
19
20
21
22
23
def __init__(self, host, port=22):
    """Initialise la connexion SFTP (sans authentification).

    Args:
        host (str): Nom d'hôte ou IP du serveur SFTP.
        port (int): Port SFTP (par défaut: 22).
    """
    self.host = host
    self.port = port
    self.transport = paramiko.Transport((self.host, self.port))
    self.sftp = None

Functions

set_working_directory

Python
set_working_directory(directory)

Change le répertoire de travail sur le serveur SFTP.

Parameters:

Name Type Description Default
directory str

Chemin distant.

 required
Source code in cmpparis/ftp.py
Python
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def set_working_directory(self, directory):
    """Change le répertoire de travail sur le serveur SFTP.

    Args:
        directory (str): Chemin distant.
    """
    try:
        self.sftp.chdir(directory)
    except Exception as e:
        subject = "FTP - working directory setting error"
        error_message = f"Error while setting working directory on SFTP server: {e}"
        print(error_message)
        send_email_to_support(subject, error_message)

        sys.exit(1)

login

Python
login(username, passwd)

S'authentifie et ouvre une session SFTP.

Parameters:

Name Type Description Default
username str

Nom d'utilisateur.

 required
passwd str

Mot de passe.

 required
Source code in cmpparis/ftp.py
Python
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def login(self, username, passwd):
    """S'authentifie et ouvre une session SFTP.

    Args:
        username (str): Nom d'utilisateur.
        passwd (str): Mot de passe.
    """
    try:
        self.transport.connect(username=username, password=passwd)
        self.sftp = paramiko.SFTPClient.from_transport(self.transport)
    except Exception as e:
        subject = "FTP - login error"
        error_message = f"Error while connecting to SFTP server: {e}"
        print(error_message)
        send_email_to_support(subject, error_message)

        sys.exit(1)

list_files

Python
list_files()

Liste les fichiers dans le répertoire courant du serveur.

Returns:

Type Description

list[str]: Noms de fichiers.
Source code in cmpparis/ftp.py
Python
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def list_files(self):
    """Liste les fichiers dans le répertoire courant du serveur.

    Returns:
        list[str]: Noms de fichiers.
    """
    try:
        return self.sftp.listdir()
    except Exception as e:
        subject = "FTP - listing files error"
        error_message = f"Error while listing files on SFTP server: {e}"
        print(error_message)
        send_email_to_support(subject, error_message)

        sys.exit(1)

upload_file

Python
upload_file(localfile, remotefile)

Transfère un fichier local vers le serveur SFTP.

Parameters:

Name Type Description Default
localfile str

Chemin du fichier local.

 required
remotefile str

Chemin distant de destination.

 required
Source code in cmpparis/ftp.py
Python
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def upload_file(self, localfile, remotefile):
    """Transfère un fichier local vers le serveur SFTP.

    Args:
        localfile (str): Chemin du fichier local.
        remotefile (str): Chemin distant de destination.
    """
    try:
        self.sftp.put(localfile, remotefile)
    except Exception as e:
        subject = "FTP - file upload error"
        error_message = f"Error while uploading file to SFTP server: {e}"
        print(error_message)
        send_email_to_support(subject, error_message)

        sys.exit(1)

download_file

Python
download_file(remotefile, localfile)

Télécharge un fichier depuis le serveur SFTP.

Parameters:

Name Type Description Default
remotefile str

Chemin distant du fichier.

 required
localfile str

Chemin local de destination.

 required
Source code in cmpparis/ftp.py
Python
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def download_file(self, remotefile, localfile):
    """Télécharge un fichier depuis le serveur SFTP.

    Args:
        remotefile (str): Chemin distant du fichier.
        localfile (str): Chemin local de destination.
    """
    try:
        self.sftp.get(remotefile, localfile)
    except Exception as e:
        subject = "FTP - file download error"
        error_message = f"Error while downloading file from SFTP server: {e}"
        print(error_message)
        send_email_to_support(subject, error_message)

        sys.exit(1)

close

Python
close()

Ferme la session SFTP et la connexion sous-jacente.

Source code in cmpparis/ftp.py
Python
109
110
111
112
113
114
def close(self):
    """Ferme la session SFTP et la connexion sous-jacente."""
    if self.sftp:
        self.sftp.close()
    if self.transport:
        self.transport.close()