@classmethodの使い方を評価してほしい

Question

@classmethodの使い方について。

以下のような使い方が妥当なのかが知りたいです。ほかに気になった点があれば指摘してください。私はプログラミング初学者のため、みなさんのご意見が聞きたいです。

ブログサイトに画像のまとめがありますが、その画像を拾い集めるプログラムを**学習目的**で作成しています。それに必要なモジュールとして作成しました。

よろしくおねがいします。

URLをパースして返すクラスです。

from LinkManager import UrlParse_to_tuple

UrlParse_to_tuple.add_parsing_link(['https://example.com/54568.html'])
# [('https://example.com/54568.html', 'example.com', '54568')]

from urllib.parse import urlparse
from urllib.parse import unquote

class UrlParse_to_tuple:
    
    @classmethod
    def to_parse(cls, url):
        r = urlparse(url)
        domain = r.netloc
        if r.query:
            # example.com/?q=132020
            query = r.query.split('=')[-1]
            return url, domain, query
        else:
            if r.path and r.path.endswith('.html'):
                # example.com/archive/432523.html
                path = r.path.split('/')[-1].split('.')[0]
                return url, domain, path
            else:
                # example.com/<％エンコードされてる場合>
                path = unquote(r.path.strip('/'))
                return url, domain, path
                
    @classmethod
    def add_parsing_link(cls, url):
        parsed_list = []
        for u in url:
            parsed_url = cls.to_parse(u)
            parsed_list.append(parsed_url)
        return parsed_list
        
if __name__ == "__main__":
    main()
    

Answer 1

ぱっと見た限り、特にクラスである必要性がないのが気になります。

クラスを作る主なモチベーションは、やはりインスタンス化してオブジェクトとして便利に使うことだと考えます。クラスのままクラスメソッドだけ呼ぶ、という使い方であれば、クラスを使わない方がすっきりします。
（ほかに継承もあるかもしれないけど、今回はそこまで想定していない気がするし、仮に継承をするとしても結論は変わらないと思います。）

以下のようにすればいいでしょう。

from urllib.parse import urlparse
from urllib.parse import unquote

def to_parse(url):
    r = urlparse(url)
    domain = r.netloc
    if r.query:
        # example.com/?q=132020
        query = r.query.split('=')[-1]
        return url, domain, query
    else:
        if r.path and r.path.endswith('.html'):
            # example.com/archive/432523.html
            path = r.path.split('/')[-1].split('.')[0]
            return url, domain, path
        else:
            # example.com/<％エンコードされてる場合>
            path = unquote(r.path.strip('/'))
            return url, domain, path

def add_parsing_link(url):
    parsed_list = []
    for u in url:
        parsed_url = to_parse(u)
        parsed_list.append(parsed_url)
    return parsed_list

add_parsing_link(['https://example.com/54568.html'])

要は、グローバルな関数にするということです。Pythonの禅のSimple is better than complex., Flat is better than nested.という考え方を踏まえると、この方が良いかと思います。

ただ、元のコードでクラスを使っていたのは、名前空間の機能を使いたい、同じ機能のものを一つにまとめたい、というモチベーションがあったのかもしれません。その場合、Pythonはモジュールという形でそういうことのできる機能を提供していますから、こちらを使えば良いのです。

単純に.pyのファイルを作ればモジュールになるので、使うのは簡単です。今回はクラスを別のファイルの中に書いているようなので、元の構造をほとんど変えないまま使うことができます。

なお、モジュール名（***.pyの***の部分）は小文字のスネークケース（変数名、関数名と同等の命名規則）が推奨されます（参考）。

link_manager.py

from urllib.parse import urlparse
from urllib.parse import unquote

def to_parse(url):
    r = urlparse(url)
    domain = r.netloc
    if r.query:
        # example.com/?q=132020
        query = r.query.split('=')[-1]
        return url, domain, query
    else:
        if r.path and r.path.endswith('.html'):
            # example.com/archive/432523.html
            path = r.path.split('/')[-1].split('.')[0]
            return url, domain, path
        else:
            # example.com/<％エンコードされてる場合>
            path = unquote(r.path.strip('/'))
            return url, domain, path

def add_parsing_link(url):
    parsed_list = []
    for u in url:
        parsed_url = to_parse(u)
        parsed_list.append(parsed_url)
    return parsed_list

これの使い方は何通りかありえます。

main.py(仮)

# パターン1
import link_manager

link_manager.add_parsing_link(['https://example.com/54568.html'])

# ---

# パターン2
from link_manager import add_parsing_link

add_parsing_link(['https://example.com/54568.html'])

好きな方を選べば良いです。

Comments

[ksgyskz]

ありがとうございます。クラスにしないとモジュールにできないと思っていました。そうやって書くんですね！そういうのをやりたかったんです。

ファイルを小分けにして管理するやりかたを知ったので、出来る範囲でやってみようと思い、上のようなコードを書きました。

お示しくださったアドバイスを参考にプログラミングの勉強をしたいと思います。
ありがとうございました。