pyproject.toml

[tool.poetry]
name = "setup-selenium-testing"
version = "0.1.6"
description = "Setup Selenium for automation testing"
authors = ["Marcel Wilson <trenchrats@gmail.com>"]
license = "MIT"
repository = "https://github.com/bandophahita/setup_selenium"
#documentation = ""
readme = "README.md"
classifiers = [
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Intended Audience :: Developers",
    "Natural Language :: English",
]
packages = [{include = "setup_selenium"}]


[tool.poetry.dependencies]
python = "^3.8"
selenium = ">=4.7.0"
semantic-version = "*"
typing-extensions = "*"

# extras
pytest = {version="*", optional = true}
black = {version="*", optional = true}
mypy = {version="*", optional = true}
ruff = {version = ">=0.2.0", optional = true}
tox = {version="*", optional = true}

[tool.poetry.extras]
dev = [
    "pytest",
    "black",
    "mypy",
    "ruff",
    "tox",
]
test = [
    "pytest",
    "tox",
]


[build-system]
requires = ["poetry-core>=1.2.0"]
build-backend = "poetry.core.masonry.api"


# LINTER CONFIGURATION & GUIDELINES 
# There is no rule that says linter configurations MUST be put in the pyproject.toml
# This is partially because not all tools support it.  That said with the move to ruff,
# this file felt like the logical place to keep any documentations regarding how or why
# configurations are the way they are.

# The general rule:
# "Linters should help, not hinder."
# If the inclination on a rule is to add a whole bunch of exceptions in various places,
# perhaps that rule should not be run regularly.


[tool.ruff]
target-version = "py38"
line-length = 88
extend-exclude = [
    ".github",
    ".pytest_cache",
    ".venv",
    "venv",
    "dockerfiles",
    "docs",
    ".coverage",
    ".coveragerc",
    ".env",
    ".env.example",
    ".flake8",
    ".gitignore",
    "alembic.ini",
    "bandit.yaml",
    "docker-compose-dev.yaml",
    "docker-compose-pro.yaml",
    "Makefile",
    "mkdocks.yml",
    "mypy.ini",
    "poetry.lock",
    "pyproject.toml",
    "pytest.ini",
    "README.md",
    ".idea",
]

[tool.ruff.lint]
select = [
    "A",  # flake8-builtins
    "ANN",  # flake8-annotations  # coming back to this one later to compare against mypy
    "ARG",  # flake8-unused-arguments
    "B",  # flake8-bugbear
    "BLE",  # flake8-blind-except
    "C4",  # flake8-comprehensions
    "D",  # pydocstyle
    "E",  # pycodestyle error
    "EM",  # flake8-errmsg
    "ERA",  # eradicate
    "F",  # Pyflakes
    "FA",  # flake8-future-annotations
#    "FBT",  # flake8-boolean-trap
    "FIX",  # flake8-fixme
    "FLY",  # flynt
    "I",  # isort
    "ICN",  # flake8-import-conventions
    "ISC",  # flake8-implicit-str-concat
    "PGH",  # pygrep-hooks
    "PIE",  # flake8-pie
    "PL",  # pylint
    "PT",  # flake8-pytest-style
    "Q",  # flake8-quotes
    "RET",  # flake8-return
    "RSE",  # flake8-raise
    "RUF",  # ruff specific
    "SIM",  # flake8-simplify
    "T10",  # flake8-debugger
    "TCH",  # flake8-type-checking
    "TD",  #TODOs
    "TRY",  # tryceratops
    "UP",  # python upgrade
    "W",  # pycodestyle warning
    "YTT",  # flake8-2020

    # may eventually use but for now these are not helpful
#    "FURB", # refurb  # needs --preview flag to run
]
ignore = [
    "ANN101",  # missing-type-self
    "ANN102",  # cls 
    "E501",   # line too long -- black will take care of this for us
    "SIM115", # use context handler for open -- situationally useful
#    "SIM300", # yoda conditions -- meh

    "PERF203", # `try`-`except` within a loop incurs performance overhead
    "PERF401", # use list comp

    # NOT OPTIONAL. MUST REMAIN AS SET
    # these are all completely unnecessary 
    "D101", # Missing docstring in public class
    "D104", # Missing docstring in public package
    "D105", # Missing docstring in magic method
    "D106", # Missing docstring in public nested class
    "D107", # Missing docstring in `__init__`
    "D202", # no blank lines after docstring
    "D203", # one-blank-line-before-class
    "D204", # blank line required after docstring
    "D205", # blank line between summary and description
    "D212", # Multi-line summary should start at the first line
    "D400", # First line should end with a period
    "D401", # imperative mood
    "D404", # First word of the docstring should not be "This"
    "D405", # Section name should be properly capitalized
    "D406", # Section name should end with a newline 
    "D407", # Missing dashed underline after section
    "D411", # Missing blank line before section
    "D412", # No blank lines allowed between a section header and its content 
    "D415", # First line should end with punctuation

    "PLC0414", # useless-import-alias
    "PLR0911", # too-many-return-statements
    "PLR0912", # too-many-branches
    "PLR0913", # too-many-arguments
    "PLR0915", # too-many-statements

    # 3.8 & 3.9 compatibility
    "UP007", # Use `X | Y` for type annotations
    "UP035", # Import from `typing` instead: `TypeAlias`
    "UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
]

extend-safe-fixes = [
    "EM101", "EM102",
    "TCH001", "TCH002", "TCH003", "TCH004",
    "C419",
    "D200", "D205",
    "PT003", "PT006", "PT018",
    "RET504",
    "UP007",
]

[tool.ruff.lint.flake8-pytest-style]
mark-parentheses = false

[tool.ruff.lint.pycodestyle]
ignore-overlong-task-comments = true

[tool.ruff.lint.isort]
combine-as-imports = true
split-on-trailing-comma = false

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"]
"tests/**" = [
    "D",  # we don't need public-API-polished docstrings in tests.
    "FBT",  # using a boolean as a test object is useful!
    "PLR",  # likewise using specific numbers and strings in tests.
]
[tool.ruff.lint.flake8-annotations]
# ignore returns types for functions that implicity or explicitly only return None
suppress-none-returning = true
allow-star-arg-any = true
#mypy-init-return = true


[tool.black]
line-length = 88
target-version = ['py311']

# 'extend-exclude' excludes files or directories in addition to the defaults
extend-exclude = '''
# A regex preceded with ^/ will apply only to files and directories
# in the root of the project.
(
    \.idea
    | \.git
    | \.mypy_cache
    | \.tox
)

'''