Tanymv / Coursework_4

0 stars 0 forks source link

Названия классов рекомендуется прописывать в CamelCase стиле #5

Open bendenko-v opened 12 months ago

bendenko-v commented 12 months ago

https://github.com/Tanymv/Coursework_4/blob/94708452c46600eb46a1ab28e4fca40f982940b6/src/main.py#L7

https://github.com/Tanymv/Coursework_4/blob/94708452c46600eb46a1ab28e4fca40f982940b6/src/main.py#L15

https://github.com/Tanymv/Coursework_4/blob/94708452c46600eb46a1ab28e4fca40f982940b6/src/main.py#L33

https://github.com/Tanymv/Coursework_4/blob/94708452c46600eb46a1ab28e4fca40f982940b6/src/main.py#L55

https://github.com/Tanymv/Coursework_4/blob/94708452c46600eb46a1ab28e4fca40f982940b6/src/main.py#L72

https://github.com/Tanymv/Coursework_4/blob/94708452c46600eb46a1ab28e4fca40f982940b6/src/main.py#L81

https://github.com/Tanymv/Coursework_4/blob/94708452c46600eb46a1ab28e4fca40f982940b6/src/main.py#L133

https://github.com/Tanymv/Coursework_4/blob/94708452c46600eb46a1ab28e4fca40f982940b6/src/main.py#L185

По поводу названий для классов. Есть гид по стилю PEP8 (https://peps.python.org/pep-0008/#descriptive-naming-styles ,https://peps.python.org/pep-0008/#class-names), который предлагает использовать так называемый CamelCase стиль для названий классов, то есть мы не используем нижние подчёркивания или другие символы в Python для классов, и вторые, третьи и т.д. слова пишем с больших букв.

Предлагаю расмотреть вот такие варианты для названий (обычно стараются максимально близко назвать класс связав название с его логикой)

from abc import ABC, abstractmethod

class ApiSites(ABC):
    @abstractmethod
    def get_vacancies(self):
        ...

class HHSite(ApiSites):
    ...

class SuperJobSite(ApiSites):
    ...

class Vacancy:  # Job_processing не является подходящим названием для вакансии
    ...

class WorkFiles(ABC):
    @abstractmethod
    def add_file(self):
        ...

class WorkFilesHH(WorkFiles):
    ...

class WorkFilesSuperJob(WorkFiles):
    ...

class ClearingFiles:
    ...