Remove project name from schema (#684)

* Remove project id API.

* Remove project name from config as part of migration.

* Fix issues with config CLI and remove project from default cfg.

* Address PR comments.

* Change the str of a project to the str of its root directory.

signac/__main__.py

@@ -73,8 +73,7 @@
 SHELL_BANNER = """Python {python_version}
 signac {signac_version} 🎨
 
-Project:\t{project_id}{job_banner}
-Root:\t\t{root_path}
+Project:\t{root_path}{job_banner}
 Workspace:\t{workspace_path}
 Size:\t\t{size}
 
@@ -561,7 +560,6 @@ def _main_import_interactive(project, origin, args):
                 banner=SHELL_BANNER_INTERACTIVE_IMPORT.format(
                     python_version=sys.version,
                     signac_version=__version__,
-                    project_id=project.id,
                     job_banner="",
                     root_path=project.root_directory(),
                     workspace_path=project.workspace,
@@ -736,16 +734,14 @@ def main_config_show(args):
         cfg = config.read_config_file(config.USER_CONFIG_FN)
     else:
         cfg = config.load_config()
-    if cfg is None:
-        if args.local and args.globalcfg:
-            mode = " local or global "
-        elif args.local:
-            mode = " local "
+    if not cfg:
+        if args.local:
+            mode = "local"
         elif args.globalcfg:
-            mode = " global "
+            mode = "global"
         else:
-            mode = ""
-        _print_err(f"Did not find a{mode}configuration file.")
+            mode = "local or global"
+        _print_err(f"Did not find a {mode} configuration file.")
         return
     for key in args.key:
         for kt in key.split("."):
@@ -771,19 +767,19 @@ def main_config_verify(args):
         cfg = config.read_config_file(config.USER_CONFIG_FN)
     else:
         cfg = config.load_config()
-    if cfg is None:
-        if args.local and args.globalcfg:
-            mode = " local or global "
-        elif args.local:
-            mode = " local "
+    if not cfg:
+        if args.local:
+            mode = "local"
         elif args.globalcfg:
-            mode = " global "
+            mode = "global"
         else:
-            mode = ""
-        raise RuntimeWarning(f"Did not find a{mode}configuration file.")
-    if cfg.filename is not None:
-        _print_err(f"Verification of config file '{cfg.filename}'.")
-    verify_config(cfg)
+            mode = "local or global"
+        _print_err(f"Did not find a {mode} configuration file.")
+        return
+    else:
+        if cfg.filename is not None:
+            _print_err(f"Verification of config file '{cfg.filename}'.")
+        verify_config(cfg)
 
 
 def main_config_set(args):
@@ -906,7 +902,6 @@ def write_history_file():
                 banner=SHELL_BANNER.format(
                     python_version=sys.version,
                     signac_version=__version__,
-                    project_id=project.id,
                     job_banner=f"\nJob:\t\t{job.id}" if job is not None else "",
                     root_path=project.root_directory(),
                     workspace_path=project.workspace,

signac/common/validate.py

@@ -15,7 +15,6 @@ def get_validator():  # noqa: D103
 
 
 cfg = """
-project = string()
 workspace_dir = string(default='workspace')
 schema_version = string(default='1')
 """

signac/contrib/migration/v1_to_v2.py

@@ -11,11 +11,14 @@
 
 from signac.common import configobj
 from signac.common.config import _get_project_config_fn
+from signac.contrib.project import Project
+from signac.synced_collections.backends.collection_json import BufferedJSONAttrDict
+
+from .v0_to_v1 import _load_config_v1
 
 # A minimal v2 config.
 _cfg = """
 schema_version = string(default='0')
-project = string()
 workspace_dir = string(default='workspace')
 """
 
@@ -34,6 +37,15 @@ def _load_config_v2(root_directory):
 
 def _migrate_v1_to_v2(root_directory):
     """Migrate from schema version 1 to version 2."""
+    # Delete project name from config and store in project doc.
+    cfg = _load_config_v1(root_directory)
+    fn_doc = os.path.join(root_directory, Project.FN_DOCUMENT)
+    doc = BufferedJSONAttrDict(filename=fn_doc, write_concern=True)
+    doc["signac_project_name"] = cfg["project"]
+    del cfg["project"]
+    cfg.write()
+
+    # Move signac.rc to .signac/config
     v1_fn = os.path.join(root_directory, "signac.rc")
     v2_fn = _get_project_config_fn(root_directory)
     os.mkdir(os.path.dirname(v2_fn))

signac/contrib/project.py

@@ -136,17 +136,6 @@ def __init__(self, config=None):
         self._config = _ProjectConfig(config)
         self._lock = RLock()
 
-        # Ensure that the project id is configured.
-        try:
-            self._id = str(self.config["project"])
-        except KeyError:
-            raise LookupError(
-                "Unable to determine project id. "
-                "Please verify that '{}' is a signac project path.".format(
-                    os.path.abspath(self.config.get("project_dir", os.getcwd()))
-                )
-            )
-
         # Ensure that the project's data schema is supported.
         self._check_schema_compatibility()
 
@@ -172,8 +161,8 @@ def __init__(self, config=None):
                 _mkdir_p(self.workspace)
             except OSError:
                 logger.error(
-                    "Error occurred while trying to create "
-                    "workspace directory for project {}.".format(self.id)
+                    "Error occurred while trying to create workspace directory for project at root "
+                    f"{self.root_directory()}."
                 )
                 raise
 
@@ -191,8 +180,7 @@ def __init__(self, config=None):
         )
 
     def __str__(self):
-        """Return the project's id."""
-        return str(self.id)
+        return str(self.root_directory())
 
     def __repr__(self):
         return "{type}.get_project({root})".format(
@@ -210,8 +198,7 @@ def _repr_html_(self):
         """
         return (
             "<p>"
-            + f"<strong>Project:</strong> {self.id}<br>"
-            + f"<strong>Root:</strong> {self.root_directory()}<br>"
+            + f"<strong>Project:</strong> {self.path}<br>"
             + f"<strong>Workspace:</strong> {self.workspace}<br>"
             + f"<strong>Size:</strong> {len(self)}"
             + "</p>"
@@ -270,18 +257,6 @@ def workspace(self):
         """
         return self._workspace
 
-    @property
-    def id(self):
-        """Get the project identifier.
-
-        Returns
-        -------
-        str
-            The project id.
-
-        """
-        return self._id
-
     def _check_schema_compatibility(self):
         """Check whether this project's data schema is compatible with this version.
 
@@ -1595,15 +1570,13 @@ def init_project(cls, *args, root=None, workspace=None, make_dir=True, **kwargs)
             if make_dir:
                 _mkdir_p(os.path.dirname(fn_config))
             config = read_config_file(fn_config)
-            config["project"] = name
             if workspace is not None:
                 config["workspace_dir"] = workspace
             config["schema_version"] = SCHEMA_VERSION
             config.write()
             project = cls.get_project(root=root)
             if name is not None:
                 project.doc[name_key] = name
-            assert project.id == str(name)
             return project
         else:
             if workspace is not None and os.path.realpath(
@@ -1647,7 +1620,7 @@ def get_project(cls, root=None, search=True, **kwargs):
         if root is None:
             root = os.getcwd()
         config = load_config(root=root, local=False)
-        if "project" not in config or (
+        if "project_dir" not in config or (
             not search
             and os.path.realpath(config["project_dir"]) != os.path.realpath(root)
         ):

tests/test_project.py

@@ -88,17 +88,13 @@ class TestProjectBase(TestJobBase):
 
 
 class TestProject(TestProjectBase):
-    def test_get(self):
-        pass
-
     def test_repr(self):
-        repr(self.project)
         p = eval(repr(self.project))
         assert repr(p) == repr(self.project)
         assert p == self.project
 
     def test_str(self):
-        str(self.project) == self.project.id
+        assert str(self.project) == self.project.root_directory()
 
     def test_root_directory(self):
         assert self._tmp_pr == self.project.root_directory()
@@ -2278,14 +2274,6 @@ def test_get_project(self):
         assert project.workspace == os.path.join(root, "workspace")
         assert project.root_directory() == root
 
-    def test_project_no_id(self):
-        root = self._tmp_dir.name
-        signac.init_project(root=root)
-        config = load_config(root)
-        del config["project"]
-        with pytest.raises(LookupError):
-            Project(config=config)
-
     def test_get_project_non_local(self):
         root = self._tmp_dir.name
         subdir = os.path.join(root, "subdir")

tests/test_shell.py

@@ -792,14 +792,9 @@ def test_config_set(self):
 
     def test_config_verify(self):
         # no config file
-        with pytest.raises(ExitCodeError):
-            self.call("python -m signac config --local verify".split(), error=True)
-        err = self.call(
-            "python -m signac config --local verify".split(),
-            error=True,
-            raise_error=False,
-        )
+        err = self.call("python -m signac config --local verify".split(), error=True)
         assert "Did not find a local configuration file" in err
+
         self.call("python -m signac init my_project".split())
         err = self.call("python -m signac config --local verify".split(), error=True)
         assert "Passed" in err