XMLからJSONデータ変換プロジェクト

python -m venv myenv

myenv\Scripts\activate

python3 -m venv myenv

source myenv/bin/activate

xmltodict==0.14.2

pip install -r requirements.txt

# 必要なライブラリをインポート
import json          # JSON形式での出力に使用
import xmltodict     # XMLを辞書形式に変換するライブラリ
import os            # ファイル操作やパス処理に使用


class DataConverter:
    # クラスの初期化メソッド
    def __init__(self, input_folder, output_folder):
        self.input_folder = input_folder    # 入力ファイルがあるフォルダパス
        self.output_folder = output_folder  # 出力ファイルを保存するフォルダパス
        self.books_data = None              # 読み込んだデータを保存する変数

    # ファイルが存在するかチェックするメソッド
    def check_file_exists(self, file_path):
        # os.path.isfile()でファイルの存在を確認
        if not os.path.isfile(file_path):
            # ファイルが見つからない場合のエラーメッセージ
            print(f"指定されたファイルが見つかりません: {file_path}")
            return False
        # ファイルが見つかった場合の確認メッセージ
        print(f"ファイルを確認しました: {file_path}")
        return True

    # XMLファイルを読み込むメソッド
    def read_xml_file(self, xml_file_path):
        try:
            # 読み込み開始のメッセージを表示
            print(f"XMLファイルを読み込み中: {xml_file_path}")
            # with文でファイルを安全に開く（自動でファイルを閉じる）
            with open(xml_file_path, 'r', encoding='utf-8') as xml_file:
                # ファイル全体を文字列として読み込み
                xml_content = xml_file.read()
            # 読み込み完了のメッセージを表示
            print("XMLファイルの読み込みが完了しました")
            # 読み込んだ内容を返す
            return xml_content
        except FileNotFoundError:
            # ファイルが見つからないエラーの処理
            print(f"エラー: ファイルが見つかりません - {xml_file_path}")
            return None
        except Exception as e:
            # その他のエラーの処理
            print(f"ファイル読み込みエラー: {str(e)}")
            return None

    # XMLデータを辞書形式に変換するメソッド
    def parse_xml_to_dict(self, xml_content):
        try:
            # パーシング開始のメッセージを表示
            print("XMLデータを解析中...")
            # xmltodict.parse()でXML文字列を辞書に変換
            parsed_data = xmltodict.parse(xml_content)
            # パーシング完了のメッセージを表示
            print("XMLデータの解析が完了しました")
            # 変換された辞書データを返す
            return parsed_data
        except Exception as e:
            # エラーが発生した場合の処理
            print(f"XMLパーシングエラー: {str(e)}")
            return None

    # 解析されたデータの構造を表示するメソッド
    def display_data_structure(self, data):
        # データが空の場合の処理
        if not data:
            print("表示するデータがありません")
            return
        
        # データ構造確認の開始メッセージ
        print("\n=== データ構造の確認 ===")
        
        # books_catalogキーが存在するかチェック
        if 'books_catalog' in data:
            catalog = data['books_catalog']
            
            # 書店情報の表示
            if 'store_info' in catalog:
                store_info = catalog['store_info']
                # get()メソッドでキーが無い場合のデフォルト値を設定
                print(f"書店名: {store_info.get('store_name', '不明')}")
                print(f"所在地: {store_info.get('location', '不明')}")
                print(f"カタログ作成日: {store_info.get('catalog_date', '不明')}")
            
            # 書籍情報の表示
            if 'books' in catalog and 'book' in catalog['books']:
                books = catalog['books']['book']
                # リストの場合は長さを取得、単一要素の場合は1
                book_count = len(books) if isinstance(books, list) else 1
                print(f"登録書籍数: {book_count}冊")
                
                # 最初の書籍をサンプルとして表示
                if isinstance(books, list) and books:
                    sample_book = books[0]
                    print(f"サンプル書籍: {sample_book.get('title', '不明')}")
                    print(f"著者: {sample_book.get('author', '不明')}")

    # XML→JSON変換の全体処理をまとめるメソッド
    def convert_xml_to_json(self, xml_filename):
        # 入力フォルダとファイル名を結合してフルパスを作成
        xml_file_path = os.path.join(self.input_folder, xml_filename)
        
        # ファイルの存在確認
        if not self.check_file_exists(xml_file_path):
            return False
        
        # XMLファイルの読み込み
        xml_content = self.read_xml_file(xml_file_path)
        if xml_content is None:
            return False
        
        # XMLデータの辞書への変換
        self.books_data = self.parse_xml_to_dict(xml_content)
        if self.books_data is None:
            return False
        
        # データ構造の確認・表示
        self.display_data_structure(self.books_data)
        return True

# プログラムのメイン処理
def main():
    # プログラム開始のメッセージ
    print("=== 書店データ変換ツール ===")
    
    # 各フォルダとファイル名の設定
    input_folder = "sample_data"           # 入力ファイルがあるフォルダ
    output_folder = "converted_data"       # 出力ファイルを保存するフォルダ
    xml_filename = "books_catalog.xml"     # 変換するXMLファイル名
    
    # DataConverterクラスのインスタンスを作成
    converter = DataConverter(input_folder, output_folder)
    
    # XML→JSON変換処理の実行
    success = converter.convert_xml_to_json(xml_filename)
    
    # 処理結果に応じたメッセージ表示
    if success:
        print("\nStep2の処理が正常に完了しました")
    else:
        print("\nStep2の処理中にエラーが発生しました")


# このファイルが直接実行された場合のみmain関数を呼び出す
if __name__ == "__main__":
    main()

python src/data_converter.py

    # 出力先フォルダを作成するメソッド
    def create_output_folder(self):
        # フォルダが存在しない場合の処理
        if not os.path.exists(self.output_folder):
            # makedirs()で指定パスにフォルダを作成
            os.makedirs(self.output_folder)
            print(f"出力フォルダを作成しました: {self.output_folder}")
        else:
            # フォルダが既に存在する場合のメッセージ
            print(f"出力フォルダが既に存在します: {self.output_folder}")

    # 辞書データをJSON文字列に変換するメソッド
    def convert_dict_to_json(self, data):
        try:
            # JSON変換開始のメッセージ
            print("辞書データをJSON形式に変換中...")
            # json.dumps()で辞書をJSON文字列に変換
            # ensure_ascii=False: 日本語文字をそのまま出力
            # indent=4: 読みやすいように4スペースでインデント
            json_data = json.dumps(data, ensure_ascii=False, indent=4)
            # 変換完了のメッセージ
            print("JSON変換が完了しました")
            # 変換されたJSON文字列を返す
            return json_data
        except Exception as e:
            # エラーが発生した場合の処理
            print(f"JSON変換エラー: {str(e)}")
            return None

    # JSON文字列をファイルに保存するメソッド
    def save_json_file(self, json_data, json_filename):
        # 出力フォルダとファイル名を結合してフルパスを作成
        json_file_path = os.path.join(self.output_folder, json_filename)
        
        try:
            # ファイル保存開始のメッセージ
            print(f"JSONファイルを保存中: {json_file_path}")
            # with文でファイルを安全に開く（書き込みモード）
            with open(json_file_path, 'w', encoding='utf-8') as json_file:
                # write()メソッドでJSON文字列をファイルに書き込み
                json_file.write(json_data)
            # 保存完了のメッセージ
            print("JSONファイルの保存が完了しました")
            return True
        except Exception as e:
            # エラーが発生した場合の処理
            print(f"ファイル保存エラー: {str(e)}")
            return False

    # 保存されたファイルのサイズを確認するメソッド
    def check_file_size(self, file_path):
        try:
            # os.path.getsize()でファイルサイズを取得（バイト単位）
            file_size = os.path.getsize(file_path)
            # 1024バイト以上の場合はKB単位で表示
            if file_size > 1024:
                size_kb = file_size / 1024
                print(f"ファイルサイズ: {size_kb:.2f} KB")
            else:
                # 1024バイト未満の場合はバイト単位で表示
                print(f"ファイルサイズ: {file_size} bytes")
            # ファイルサイズを返す
            return file_size
        except Exception as e:
            # エラーが発生した場合の処理
            print(f"ファイルサイズ取得エラー: {str(e)}")
            return 0

    # XML→JSON変換の全体処理をまとめるメソッド（更新版）
    def convert_xml_to_json(self, xml_filename, json_filename):
        # 入力フォルダとファイル名を結合してフルパスを作成
        xml_file_path = os.path.join(self.input_folder, xml_filename)
        
        # ファイルの存在確認
        if not self.check_file_exists(xml_file_path):
            return False
        
        # XMLファイルの読み込み
        xml_content = self.read_xml_file(xml_file_path)
        if xml_content is None:
            return False
        
        # XMLデータの辞書への変換
        self.books_data = self.parse_xml_to_dict(xml_content)
        if self.books_data is None:
            return False
        
        # データ構造確認をコメントアウト（詳細表示が不要になったため）
        # self.display_data_structure(self.books_data)
        
        # 出力フォルダの作成
        self.create_output_folder()
        
        # 辞書データをJSON文字列に変換
        json_data = self.convert_dict_to_json(self.books_data)
        if json_data is None:
            return False
        
        # JSON文字列をファイルに保存
        success = self.save_json_file(json_data, json_filename)
        if success:
            # 保存成功時はファイルサイズも確認
            json_file_path = os.path.join(self.output_folder, json_filename)
            self.check_file_size(json_file_path)
        
        # 処理結果を返す
        return success

    # 保存されたJSONファイルの内容を確認するメソッド
    def verify_conversion_result(self, json_filename):
        # 出力フォルダとファイル名を結合してフルパスを作成
        json_file_path = os.path.join(self.output_folder, json_filename)
        
        # ファイルの存在確認
        if not self.check_file_exists(json_file_path):
            return False
        
        try:
            # with文でJSONファイルを読み込み
            with open(json_file_path, 'r', encoding='utf-8') as json_file:
                # json.load()でJSONファイルを辞書として読み込み
                loaded_data = json.load(json_file)
            
            # 変換結果確認の開始メッセージ
            print("\n=== 変換結果の確認 ===")
            # books_catalogキーが存在するかチェック
            if 'books_catalog' in loaded_data:
                catalog = loaded_data['books_catalog']
                
                # 書店情報の表示
                if 'store_info' in catalog:
                    store_info = catalog['store_info']
                    print(f"書店名: {store_info.get('store_name', '不明')}")
                
                # 書籍数の表示
                if 'books' in catalog and 'book' in catalog['books']:
                    books = catalog['books']['book']
                    # リストの場合は長さを取得、単一要素の場合は1
                    book_count = len(books) if isinstance(books, list) else 1
                    print(f"変換済み書籍数: {book_count}冊")
            
            return True
        except Exception as e:
            # エラーが発生した場合の処理
            print(f"変換結果確認エラー: {str(e)}")
            return False

# プログラムのメイン処理（更新版）
def main():
    # プログラム開始のメッセージ
    print("=== 書店データ変換ツール ===")
    
    # 各フォルダとファイル名の設定
    input_folder = "sample_data"               # 入力ファイルがあるフォルダ
    output_folder = "converted_data"           # 出力ファイルを保存するフォルダ
    xml_filename = "books_catalog.xml"         # 変換するXMLファイル名
    json_filename = "converted_books.json"     # 出力するJSONファイル名
    
    # DataConverterクラスのインスタンスを作成
    converter = DataConverter(input_folder, output_folder)
    
    # XML→JSON変換処理の実行（引数にJSONファイル名も追加）
    success = converter.convert_xml_to_json(xml_filename, json_filename)
    
    # 処理結果に応じたメッセージ表示
    if success:
        print("\nXML→JSON変換が正常に完了しました")
        # 変換結果の確認処理を実行
        converter.verify_conversion_result(json_filename)
        # Step3完了メッセージをコメントアウト
        # print("\nStep3の処理が正常に完了しました")
    else:
        print("\nXML→JSON変換中にエラーが発生しました")


# このファイルが直接実行された場合のみmain関数を呼び出す
if __name__ == "__main__":
    main()

python src/data_converter.py

# Virtual environment
myenv/

# Converted data files
converted_data/
*.json
*.xml

# 書店システム用XMLデータ変換ツール

## プロジェクト内容
書店の書籍カタログXMLファイルをJSON形式に変換するデータ変換ツールです。XMLデータの読み込み、パーシング、JSON変換、ファイル保存まで一連の処理を自動化し、書店システムのデータ管理を効率化します。PythonによるXML処理とJSONデータ変換技術を学習することを目的として実装しました。

## プロジェクト構成
```
bookstore_converter/
├── src/
│   └── data_converter.py    # メインプログラム
├── sample_data/
│   └── books_catalog.xml    # サンプル書籍データ
├── converted_data/          # 変換結果出力フォルダ
├── requirements.txt         # 依存関係管理
├── README.md               # プロジェクト説明書
└── .gitignore              # Git除外ファイル設定
```

## 必要要件/開発環境
- **Python 3.7以上**
- **VSCode** (開発環境)
- **Git** (バージョン管理)

### 使用ライブラリ
- **xmltodict** XMLデータの辞書変換処理
- **json** JSON形式データの変換・保存処理
- **os** ファイルシステム操作

## 機能
- **XMLファイル読み込み** 書籍カタログXMLの自動読み込み
- **データ構造解析** XMLデータの階層構造を辞書形式に変換
- **JSON形式変換** 辞書データをJSON文字列に変換
- **ファイル自動保存** 変換結果を指定フォルダに保存
- **フォルダ自動作成** 出力フォルダの存在確認と自動作成
- **変換結果確認** 保存されたJSONファイルの内容検証
- **エラーハンドリング** ファイル操作や変換処理のエラー対応
- **ファイルサイズ確認** 変換後ファイルのサイズ表示

## 実行方法

### 1. リポジトリのクローン
```bash
git clone https://github.com/yourusername/bookstore_converter.git
cd bookstore_converter
```

### 2. 仮想環境の作成・アクティベート

**Windows**
```bash
python -m venv myenv
myenv\Scripts\activate
```

**macOS**
```bash
python3 -m venv myenv
source myenv/bin/activate
```

### 3. 依存関係のインストール
```bash
pip install -r requirements.txt
```

### 4. プログラムの実行
```bash
python src/data_converter.py
```

実行後、sample_data/books_catalog.xmlがJSONファイルに変換され、converted_dataフォルダに保存されます。

## データ形式について
- **入力データ** XML形式の書籍カタログファイル
- **出力データ** JSON形式の変換済みデータファイル
- **サンプルデータ** 8冊の書籍情報を含む実データ

## 開発者
YuYu