HOWTO · Python

Obter o nome do ficheiro do caminho em Python

Este tutorial demonstrará diferentes métodos em Python para extrair o nome do ficheiro de um caminho de ficheiro, incluindo os.path.split(), os.path.basename(), ntpath.basename() e pathlib.Path.name.

Nesta página

Na programação, muitas vezes precisamos de extrair o nome do ficheiro de um determinado caminho de ficheiro. Considere um cenário em que temos um caminho de ficheiro, como C:\Documents\Project\file.txt, e precisamos de extrair apenas o nome do ficheiro, ou seja, file.txt. Esta é uma tarefa de rotina na gestão de ficheiros, na análise de dados e no desenvolvimento web, e o Python oferece várias formas de a realizar.

Este tutorial apresenta quatro métodos para obter um nome de ficheiro a partir de um caminho em Python: os.path.split(), os.path.basename(), ntpath.basename() e pathlib.Path.name. Diferem principalmente naquilo que lhe dão além do nome do ficheiro, e na forma como tratam caminhos escritos para um sistema operativo diferente daquele em que o seu código é executado.

Utilize a função os.path.split() para obter o nome do ficheiro a partir do caminho em Python

A função os.path.split() divide um caminho de ficheiro nos seus componentes de diretório e nome de ficheiro, para que possa recuperar apenas a parte do nome do ficheiro — ou manter ambas as partes, se também precisar do diretório.

Sintaxe:

import os

directory, filename = os.path.split(path)

Parâmetros: A função os.path.split() aceita um único parâmetro.

  • path: Este parâmetro representa o caminho do ficheiro do qual queremos extrair o nome do ficheiro. Pode ser uma cadeia de carateres que contém o caminho absoluto ou relativo do ficheiro.

Valores de retorno: A função devolve um tuplo que contém dois elementos.

  • directory: Esta variável guarda o componente de diretório do caminho, excluindo o nome do ficheiro.

  • filename: Esta variável contém o nome do ficheiro extraído do caminho.

O seguinte excerto de código demonstra como podemos obter um nome de ficheiro a partir de um caminho em Python utilizando a função os.path.split().

import os

directory, filename = os.path.split("MyFolder/MySubFolder/MyFile.txt")
print(directory)
print(filename)

Resultado:

MyFolder/MySubFolder
MyFile.txt

A variável directory guarda MyFolder/MySubFolder, o componente de diretório do caminho do ficheiro, e a variável filename armazena MyFile.txt, o nome de ficheiro extraído. Utilize este método quando precisar de ambas as partes; se só precisar do nome do ficheiro, o método seguinte é mais curto.

Utilize a função os.path.basename() para obter o nome do ficheiro a partir do caminho em Python

A função os.path.basename() devolve o último componente de um caminho, que é normalmente o nome do ficheiro. Faz parte do módulo os.path, cujas regras de separador seguem o sistema operativo em que o código é executado.

Sintaxe:

import os

filename = os.path.basename(path)

Parâmetros: A função os.path.basename() aceita um único parâmetro.

  • path: Este parâmetro representa o caminho do ficheiro do qual queremos extrair o nome do ficheiro. Pode ser uma cadeia de carateres que contém o caminho absoluto ou relativo do ficheiro.

Valor de retorno: A função devolve uma cadeia de carateres que representa o nome de ficheiro extraído do caminho fornecido.

Embora tanto os.path.basename() como os.path.split() possam extrair nomes de ficheiros de caminhos, os.path.basename() concentra-se apenas no componente do nome do ficheiro e devolve-o como uma cadeia de carateres, o que a torna a escolha mais simples quando não precisa da parte do diretório.

import os

filename = os.path.basename("MyFolder/MySubFolder/MyFile.txt")
print(filename)

Resultado:

MyFile.txt

O resultado, o nome do ficheiro MyFile.txt, é atribuído à variável filename e impresso.

Utilize a biblioteca ntpath para obter o nome do ficheiro a partir do caminho em Python

O módulo ntpath do Python implementa a manipulação de caminhos para caminhos do Windows, seja qual for o sistema em que o seu código é realmente executado. Isto é importante quando tem de processar caminhos ao estilo do Windows numa máquina Linux ou macOS: aí, os.path.basename() não trata a barra invertida como separador, pelo que os.path.basename("MyFolder\\MySubFolder\\MyFile.txt") devolve a cadeia inteira, enquanto ntpath.basename() devolve o nome do ficheiro.

Sintaxe:

import ntpath

filename = ntpath.basename(path)

Parâmetros: A função ntpath.basename() aceita um único parâmetro.

  • path: Este parâmetro representa o caminho do ficheiro do qual queremos extrair o nome do ficheiro. Pode ser uma cadeia de carateres que contém o caminho absoluto ou relativo do ficheiro.

Valor de retorno: A função devolve uma cadeia de carateres que representa o nome de ficheiro extraído do caminho fornecido.

O seguinte excerto de código demonstra como podemos obter um nome de ficheiro a partir de um caminho do Windows em Python utilizando a função ntpath.basename().

import ntpath

filename = ntpath.basename("MyFolder\\MySubFolder\\MyFile.txt")
print(filename)

Resultado:

MyFile.txt

Utilize ntpath quando os caminhos que processa são caminhos do Windows, mas o seu código pode ser executado em qualquer lugar; numa máquina Windows, o os.path já segue as mesmas regras, pelo que os dois se comportam da mesma forma.

Utilize o módulo pathlib para obter o nome do ficheiro a partir do caminho em Python

O módulo pathlib fornece uma abordagem orientada a objetos para trabalhar com caminhos de ficheiros. A sua classe Path encapsula as operações relacionadas com caminhos, e o nome do ficheiro está disponível diretamente como o atributo .name de um objeto Path.

from pathlib import Path

filename = Path("MyFolder/MySubFolder/MyFile.txt").name
print(filename)

Resultado:

MyFile.txt

Para além de .name, o mesmo objeto dá-lhe o diretório pai (.parent), a extensão (.suffix) e o nome do ficheiro sem a extensão (.stem), o que torna o pathlib a escolha conveniente quando precisa de mais do que apenas o nome do ficheiro.

Conclusão

Explorámos 4 métodos diferentes em Python para extrair o nome do ficheiro de um caminho de ficheiro: os.path.split(), os.path.basename(), ntpath.basename() e pathlib.Path.name. Cada método tem vantagens e desvantagens, o que os torna adequados a diferentes cenários.

O método os.path.split() pode dividir um caminho nos seus componentes de diretório e nome de ficheiro. Esta granularidade permite um maior controlo sobre o caminho, mas requer código adicional para aceder apenas ao nome do ficheiro. No entanto, funciona em diferentes sistemas operativos, o que o torna versátil.

Por outro lado, os.path.basename() oferece uma abordagem mais simples ao extrair diretamente o nome do ficheiro do caminho. É compatível com várias plataformas e oferece uma solução direta. No entanto, devolve apenas o nome do ficheiro como uma cadeia de carateres.

Para caminhos específicos do Windows, ntpath.basename() foi concebido para lidar com estes caminhos em qualquer sistema operativo. Extrai diretamente o nome do ficheiro sem necessidade de código adicional. No entanto, está limitado a caminhos do Windows e não tem compatibilidade multiplataforma.

Por último, pathlib.Path.name fornece uma abordagem orientada a objetos para trabalhar com caminhos. Permite mais manipulação de caminhos e integra-se bem com outras funcionalidades do pathlib. No entanto, introduz alguma complexidade para a simples extração do nome do ficheiro e requer a importação do módulo pathlib.