Pythonのlistdir関数の使い方を現役エンジニアが解説【初心者向け】

初心者向けにPythonのlistdir関数の使い方について現役エンジニアが解説しています。listdir関数とは、OSモジュールの関数であり、引数のディレクトリの中にあるファイル・ディレクトリ名のリストを取得することができます。listdir関数と組み合わせて使われる関数も解説します。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Pythonのlistdir関数の使い方について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

 

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まるでしょう。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonのlistdir関数の使い方について詳しく説明していくね!

大石ゆかり

お願いします!

 

listdir関数の使い方

ファイルやパスを操作するOSモジュールの中に、listdir()関数があります。

listdir()関数はディレクトリへのパスを引数に取り、その因数は相対パス・絶対パスのどちらでも構いません。

関数を実行すると、そのディレクトリの中にあるファイル・ディレクトリ名のリストを取得することができます。

 

実際に書いてみよう

実際にコードを書いて解説していきましょう。

ここではカレントディレクトリに存在するファイル名およびディレクトリ名を出力しており、「.」はカレントディレクトリ、「..」は親ディレクトリを表します。

import os
data_list = os.listdir('.')    #カレントディレクトリを指定
for data in data_list:
    print(data)

listdir()を用いると、このように簡単にファイルやディレクトリの一覧を取得することが可能です。

フォルダの整理やちょっとした作業を自動化したいときには有効だといえます。

 

[PR] Pythonで挫折しない学習方法を動画で公開中

listdir関数と組み合わせて使うと便利な関数

ここでは、listdir関数と組み合わせて使える便利な関数をみていきます。

代表的なものは以下のとおりです。

os.getcwd()
現在作業中のフォルダ(カレントワーキングディレクトリ)を取得することが可能です。

>>>os.getcwd()
'/Users/masaki/test'

os.makedirs(path)
新しいディレクトリを作ります。

>>>os. makedirs ('Users/masaki/new_test')
#新しいディレクトリが作成されます。

os.remove(path)
引数に指定したファイルを削除することが可能です。

>>> os.remove('test1.py')
#指定したファイルが削除されます。

os.rmdir(path)
引数に指定したディレクトリを削除できます。

>>> os.mkdir('test_folder')
#指定したディレクトリが削除されます。

os.rename(path1,path2)
ファイル名を変更することが可能です。

>>>os.rename('before.py','after.py')
#左のファイル名が右のファイル名に変更されます。

os.path.abspath(path)
引数に渡した相対パスを絶対パスにして返すことが可能です。

>>>os.path.abspath('.')
'/Users/masaki/test'

os.path.relpath(path, start)
引数に渡したstartからpathへの相対パスを返します。

>>> os.path.relpath('Users', 'Users/masaki')
'..'

os.path.join()
絶対パスを作成するのに使用される関数です。

>>> os.path.join('Users','masaki', 'test2')
'Users/masaki/test2'

実は今回紹介したもの以外にも、OSモジュールには多くの関数が用意されています。

コードを書いていく中で「こんな機能を持った関数が欲しい」と、思った場合にはその都度調べてみましょう。

まとめ

この記事では、listdir関数の使い方について解説しました。

listdir関数をはじめとしたosモジュールの関数を使いこなせるようになると、プログラムでできることの幅が飛躍的に広がります。

ぜひ皆さんもosモジュールを使いこなして、日々の作業を効率化してみてください。

 

執筆してくれたメンター

柴山真沙希(しばやままさき)

大手IT企業などでエンジニアとして2年ほど勤務した後、個人事業主としてプログラミングスクール「エンペサール」を経営。

子供から大人まで幅広い層を対象にプログラミングを教えている。

得意言語はPython, HTML, CSSで、機械学習やデータ分析、スクレイピングなどが得意。

サッカー観戦や読書が趣味である。

 

大石ゆかり

Pythonのlistdir関数の使い方がよくわかったので良かったです!

田島悠介

ゆかりちゃん、今後も分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、Pythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。