diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000000..635974a340 --- /dev/null +++ b/.clang-format @@ -0,0 +1,53 @@ +# clang-format file taken from: +# https://github.com/googleapis/google-cloud-cpp + +# Use the Google style in this project. +BasedOnStyle: Google + +# Some folks prefer to write "int& foo" while others prefer "int &foo". The +# Google Style Guide only asks for consistency within a project, we chose +# "int& foo" for this project: +DerivePointerAlignment: false +PointerAlignment: Left + +# The Google Style Guide only asks for consistency w.r.t. "east const" vs. +# "const west" alignment of cv-qualifiers. In this project we use "east const". +QualifierAlignment: Right + +IncludeBlocks: Merge +IncludeCategories: + # Matches common headers first, but sorts them after project includes + - Regex: '^\"google/cloud/internal/disable_deprecation_warnings.inc\"$' + Priority: -1 + - Regex: '^\"google/cloud/(internal/|grpc_utils/|testing_util/|[^/]+\.h)' + Priority: 1000 + - Regex: '^\"google/cloud/' # project includes should sort first + Priority: 500 + - Regex: '^\"generator/' # project includes should sort first + Priority: 500 + - Regex: '^\"generator/internal/' # project internals second + Priority: 1000 + - Regex: '^\"generator/testing/' # testing helpers third + Priority: 1100 + - Regex: '^\"' # And then includes from other projects or the system + Priority: 1500 + - Regex: '^' + Priority: 4000 + - Regex: '^<[^/]*>' + Priority: 5000 + +# Format raw string literals with a `pb` or `proto` tag as proto. +RawStringFormats: + - Language: TextProto + Delimiters: + - 'pb' + - 'proto' + BasedOnStyle: Google + +CommentPragmas: '(@copydoc|@copybrief|@see|@overload)' diff --git a/.cmake-format.yaml b/.cmake-format.yaml new file mode 100644 index 0000000000..c4a575eeed --- /dev/null +++ b/.cmake-format.yaml @@ -0,0 +1,18 @@ +additional_commands: + foo: + flags: + - BAR + - BAZ + kwargs: + DEPENDS: '*' + HEADERS: '*' + SOURCES: '*' +bullet_char: '*' +dangle_parens: false +enum_char: . +line_ending: unix +line_width: 120 +max_pargs_hwrap: 3 +separate_ctrl_name_with_space: false +separate_fn_name_with_space: false +tab_size: 2 diff --git a/.gitignore b/.gitignore index 5315c68f81..cd69541f4f 100644 --- a/.gitignore +++ b/.gitignore @@ -60,3 +60,5 @@ Package.resolved # Visual Studio generated files open_spiel/.vs /.env + +open_spiel.egg-info/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000000..0bea622108 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,95 @@ +# To run all pre-commit checks, use: +# +# pre-commit run -a +# +# To install pre-commit hooks that run every time you commit: +# +# pre-commit install +# + + +repos: + # Standard hooks + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: "v4.4.0" + hooks: + - id: check-added-large-files + - id: check-case-conflict + # Check docstring-first currently clashes with an integrated file: + # open_spiel/python/algorithms/psro_v2/strategy_selectors.py:281: Multiple module docstrings (first docstring on line 15). + # - id: check-docstring-first + - id: check-merge-conflict + - id: check-symlinks + - id: check-toml + - id: check-yaml + - id: debug-statements + - id: end-of-file-fixer + - id: mixed-line-ending + - id: requirements-txt-fixer + - id: trailing-whitespace + + # Check for basic python "dont's" + - repo: https://github.com/pre-commit/pygrep-hooks + rev: "v1.10.0" + hooks: + - id: python-check-blanket-noqa + - id: python-check-blanket-type-ignore + # Python-no-log-warn clashes in multiple places where logging.warn has been used + # - id: python-no-log-warn + - id: python-no-eval + - id: python-use-type-annotations + + # Sort includes + - repo: https://github.com/PyCQA/isort + rev: "5.12.0" + hooks: + - id: isort + +# # Format Python code with black +# black uses an uncompromisable 4-indent as the formatting basis of +# python files which clashes with google's pylint configuration. +# That's why we are using pyink instead which allows 2-indent. +# - repo: https://github.com/psf/black +# rev: 23.3.0 +# hooks: +# - id: black +# language_version: python3 +# types: [ python ] + + # Format Python code with pyink + - repo: https://github.com/google/pyink + rev: 23.3.0 + hooks: + - id: pyink + language_version: python3 + types: [python] + + # Clang-format the C++ part of the code base automatically + - repo: https://github.com/pre-commit/mirrors-clang-format + rev: "v16.0.3" + hooks: + - id: clang-format + types_or: [ c++, c, cuda ] + + # CMake format the CMakeLists.txt files + - repo: https://github.com/cheshirekow/cmake-format-precommit + rev: v0.6.13 + hooks: + - id: cmake-format + additional_dependencies: + - pyyaml + + # Lint python code with PyLint + - repo: local + hooks: + - id: pylint + name: pylint + entry: pylint + language: system + types: [ python ] + args: + [ + "-rn", # Only display messages + "-sn", # Don't display the score + "--rcfile=.pylintrc", + ] diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000000..140a876ec0 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,429 @@ +# This Pylint rcfile contains a best-effort configuration to uphold the +# best-practices and style described in the Google Python style guide: +# https://google.github.io/styleguide/pyguide.html +# +# Its canonical open-source location is: +# https://google.github.io/styleguide/pylintrc + +[MASTER] + +# Files or directories to be skipped. They should be base names, not paths. +ignore=third_party + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. +ignore-patterns= + +# Pickle collected data for later comparisons. +persistent=no + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Use multiple processes to speed up Pylint. +jobs=4 + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +#enable= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +disable=abstract-method, + apply-builtin, + arguments-differ, + attribute-defined-outside-init, + backtick, + bad-option-value, + basestring-builtin, + buffer-builtin, + c-extension-no-member, + consider-using-enumerate, + cmp-builtin, + cmp-method, + coerce-builtin, + coerce-method, + delslice-method, + div-method, + duplicate-code, + eq-without-hash, + execfile-builtin, + file-builtin, + filter-builtin-not-iterating, + fixme, + getslice-method, + global-statement, + hex-method, + idiv-method, + implicit-str-concat, + import-error, + import-self, + import-star-module-level, + inconsistent-return-statements, + input-builtin, + intern-builtin, + invalid-str-codec, + locally-disabled, + long-builtin, + long-suffix, + map-builtin-not-iterating, + misplaced-comparison-constant, + missing-function-docstring, + metaclass-assignment, + next-method-called, + next-method-defined, + no-absolute-import, + no-else-break, + no-else-continue, + no-else-raise, + no-else-return, + no-init, # added + no-member, + no-name-in-module, + no-self-use, + nonzero-method, + oct-method, + old-division, + old-ne-operator, + old-octal-literal, + old-raise-syntax, + parameter-unpacking, + print-statement, + raising-string, + range-builtin-not-iterating, + raw_input-builtin, + rdiv-method, + reduce-builtin, + relative-import, + reload-builtin, + round-builtin, + setslice-method, + signature-differs, + standarderror-builtin, + suppressed-message, + sys-max-int, + too-few-public-methods, + too-many-ancestors, + too-many-arguments, + too-many-boolean-expressions, + too-many-branches, + too-many-instance-attributes, + too-many-locals, + too-many-nested-blocks, + too-many-public-methods, + too-many-return-statements, + too-many-statements, + trailing-newlines, + unichr-builtin, + unicode-builtin, + unnecessary-pass, + unpacking-in-except, + useless-else-on-loop, + useless-object-inheritance, + useless-suppression, + using-cmp-argument, + wrong-import-order, + xrange-builtin, + zip-builtin-not-iterating, + + +[REPORTS] + +# Set the output format. Available formats are text, parseable, colorized, msvs +# (visual studio) and html. You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + + +[BASIC] + +# Good variable names which should always be accepted, separated by a comma +good-names=main,_ + +# Bad variable names which should always be refused, separated by a comma +bad-names= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty,cached_property.cached_property,cached_property.threaded_cached_property,cached_property.cached_property_with_ttl,cached_property.threaded_cached_property_with_ttl + +# Regular expression matching correct function names +function-rgx=^(?:(?PsetUp|tearDown|setUpModule|tearDownModule)|(?P_?[A-Z][a-zA-Z0-9]*)|(?P_?[a-z][a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression matching correct constant names +const-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ + +# Regular expression matching correct attribute names +attr-rgx=^_{0,2}[a-z][a-z0-9_]*$ + +# Regular expression matching correct argument names +argument-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=^(_?[A-Z][A-Z0-9_]*|__[a-z0-9_]+__|_?[a-z][a-z0-9_]*)$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=^[a-z][a-z0-9_]*$ + +# Regular expression matching correct class names +class-rgx=^_?[A-Z][a-zA-Z0-9]*$ + +# Regular expression matching correct module names +module-rgx=^(_?[a-z][a-z0-9_]*|__init__)$ + +# Regular expression matching correct method names +method-rgx=(?x)^(?:(?P_[a-z0-9_]+__|runTest|setUp|tearDown|setUpTestCase|tearDownTestCase|setupSelf|tearDownClass|setUpClass|(test|assert)_*[A-Z0-9][a-zA-Z0-9_]*|next)|(?P_{0,2}[A-Z][a-zA-Z0-9_]*)|(?P_{0,2}[a-z][a-z0-9_]*))$ + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=(__.*__|main|test.*|.*test|.*Test)$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=10 + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager,contextlib2.contextmanager + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + + +[FORMAT] + +# Maximum number of characters on a single line. +max-line-length=80 + +# TODO(https://github.com/PyCQA/pylint/issues/3352): Direct pylint to exempt +# lines made too long by directives to pytype. + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=(?x)( + ^\s*(\#\ )??$| + ^\s*(from\s+\S+\s+)?import\s+.+$) + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=yes + +# Maximum number of lines in a module +max-module-lines=99999 + +# String used as indentation unit. The internal Google style guide mandates 2 +# spaces. Google's externaly-published style guide says 4, consistent with +# PEP 8. Here, we use 2 spaces, for conformity with many open-sourced Google +# projects (like TensorFlow). +indent-string=' ' + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=TODO + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=yes + + +[VARIABLES] + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=^\*{0,2}(_$|unused_|dummy_) + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six,six.moves,past.builtins,future.builtins,functools + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging,absl.logging,tensorflow.io.logging + + +[SIMILARITIES] + +# Minimum lines number of a similarity. +min-similarity-lines=4 + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[IMPORTS] + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub, + TERMIOS, + Bastion, + rexec, + sets + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant, absl + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls, + class_ + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=builtins.StandardError, + builtins.Exception, + builtins.BaseException diff --git a/open_spiel/python/mfg/games/predator_prey.py b/open_spiel/python/mfg/games/predator_prey.py index 81527da2c4..0adbcf8534 100644 --- a/open_spiel/python/mfg/games/predator_prey.py +++ b/open_spiel/python/mfg/games/predator_prey.py @@ -312,7 +312,7 @@ def __init__(self, game, population=None): if self._population is not None: assert 0 <= self._population < self.num_players() # When set, [2] numpy array representing the x, y position on the grid. - self._pos = None # type: Optional[np.ndarray] + self._pos: Optional[np.ndarray] = None self._t = 0 self.size = game.size # Number of states in the grid. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000000..026feeea28 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,78 @@ +[build-system] +requires = ["setuptools>=61", "cmake>=3.17"] +build-backend = "setuptools.build_meta" + +[project] +name = "open_spiel" +version = "1.2" +license = { file = "LICENSE" } +description = "A Framework for Reinforcement Learning in Games" +requires-python = ">=3.7" +authors = [ + { name = "The OpenSpiel authors", email = "open_spiel@google.com" }, +] +dynamic = ["readme", "dependencies"] + +[tool.setuptools.dynamic] +readme = { file = "README.md", content-type = "text/markdown"} +dependencies = { file = "requirements.txt" } + +[project.optional-dependencies] +dev = [ + "pre-commit", + "pylint" +] + +[project.urls] +homepage = "https://github.com/deepmind/open_spiel" + +[tool.setuptools] +zip-safe = false + + +[tool.setuptools.packages.find] +where = ["."] +include = ["open_spiel", "open_spiel.*"] + + +[tool.pyink] +line-length = 80 +pyink-indentation = 2 +include = '\.pyi?$' +exclude = ''' +/( +\.eggs +| \.git +| \.hg +| \.mypy_cache +| \.nox +| \.tox +| \.venv +| _build +| buck-out +| build +| dist +)/ +''' + +[tool.black] +line-length = 80 +include = '\.pyi?$' +exclude = ''' +/( +\.eggs +| \.git +| \.hg +| \.mypy_cache +| \.nox +| \.tox +| \.venv +| _build +| buck-out +| build +| dist +)/ +''' + +[tool.isort] +profile = "black" diff --git a/setup.py b/setup.py index b256865810..ec5bdb0a52 100644 --- a/setup.py +++ b/setup.py @@ -14,8 +14,7 @@ """The setup script for setuptools. -See https://setuptools.readthedocs.io/en/latest/setuptools.html -""" +See https://setuptools.readthedocs.io/en/latest/setuptools.html""" import os import subprocess @@ -49,14 +48,16 @@ def run(self): self.build_extension(ext) def _check_build_environment(self): - """Check for required build tools: CMake, C++ compiler, and python dev.""" + """ + Check for required build tools: CMake, C++ compiler, and python dev. + """ try: subprocess.check_call(["cmake", "--version"]) except OSError as e: ext_names = ", ".join(e.name for e in self.extensions) raise RuntimeError( - "CMake must be installed to build" + - f"the following extensions: {ext_names}") from e + f"CMake must be installed to build the following extensions: {ext_names}" # pylint: disable=line-too-long + ) from e print("Found CMake") cxx = "clang++" @@ -67,15 +68,16 @@ def _check_build_environment(self): except OSError as e: ext_names = ", ".join(e.name for e in self.extensions) raise RuntimeError( - "A C++ compiler that supports c++17 must be installed to build the " - + "following extensions: {}".format(ext_names) - + ". We recommend: Clang version >= 7.0.0." + f"A C++ compiler that supports c++17 must be installed to build" + f" the following extensions: {ext_names}." + f"We recommend: Clang version >= 7.0.0." ) from e - print("Found C++ compiler: {}".format(cxx)) + print(f"Found C++ compiler: {cxx}") def build_extension(self, ext): extension_dir = os.path.abspath( - os.path.dirname(self.get_ext_fullpath(ext.name))) + os.path.dirname(self.get_ext_fullpath(ext.name)) + ) cxx = "clang++" if os.environ.get("CXX") is not None: cxx = os.environ.get("CXX") @@ -88,58 +90,31 @@ def build_extension(self, ext): if not os.path.exists(self.build_temp): os.makedirs(self.build_temp) subprocess.check_call( - ["cmake", ext.sourcedir] + cmake_args, cwd=self.build_temp, - env=env) + ["cmake", ext.sourcedir] + cmake_args, + cwd=self.build_temp, + env=env, + ) if os.environ.get("OPEN_SPIEL_BUILD_ALL") is not None: # Build everything (necessary for nox tests) - subprocess.check_call(["make", f"-j{os.cpu_count()}"], - cwd=self.build_temp, - env=env) + subprocess.check_call( + ["make", f"-j{os.cpu_count()}"], + cwd=self.build_temp, + env=env, + ) else: # Build only pyspiel (for pip package) - subprocess.check_call(["make", "pyspiel", f"-j{os.cpu_count()}"], - cwd=self.build_temp, - env=env) - - -def _get_requirements(requirements_file): # pylint: disable=g-doc-args - """Returns a list of dependencies for setup() from requirements.txt. - - Currently a requirements.txt is being used to specify dependencies. In order - to avoid specifying it in two places, we're going to use that file as the - source of truth. - """ - with open(requirements_file) as f: - return [_parse_line(line) for line in f if line] - - -def _parse_line(s): - """Parses a line of a requirements.txt file.""" - requirement, *_ = s.split("#") - return requirement.strip() - + subprocess.check_call( + [ + "make", + "pyspiel", + f"-j{os.cpu_count()}", + ], + cwd=self.build_temp, + env=env, + ) -# Get the requirements from file. During nox tests, this is in the current -# directory, but when installing from pip it is in the parent directory -req_file = "" -if os.path.exists("requirements.txt"): - req_file = "requirements.txt" -else: - req_file = "../requirements.txt" setuptools.setup( - name="open_spiel", - version="1.4", - license="Apache 2.0", - author="The OpenSpiel authors", - author_email="open_spiel@google.com", - description="A Framework for Reinforcement Learning in Games", - long_description=open("README.md").read(), - long_description_content_type="text/markdown", - url="https://github.com/deepmind/open_spiel", - install_requires=_get_requirements(req_file), - python_requires=">=3.8", ext_modules=[CMakeExtension("pyspiel", sourcedir="open_spiel")], cmdclass={"build_ext": BuildExt}, - zip_safe=False, - packages=setuptools.find_packages(include=["open_spiel", "open_spiel.*"])) +)