Skip to content

Commit b31ade0

Browse files
mohammad-alisafaeemohammad-alisafaee
authored
fix: make usage of name and slug consistent (#3620)
1 parent db9f93b commit b31ade0

File tree

441 files changed

+2515
-1952
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

441 files changed

+2515
-1952
lines changed

‎AUTHORS.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎CHANGES.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎Makefile

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
# -*- coding: utf-8 -*-
2-
#
3-
# Copyright 2017-2023 - Swiss Data Science Center (SDSC)
4-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
53
# Eidgenössische Technische Hochschule Zürich (ETHZ).
64
#
75
# Licensed under the Apache License, Version 2.0 (the "License");

‎QA_PROTOCOL.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/_ext/cheatsheet.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
# -*- coding: utf-8 -*-
2-
#
3-
# Copyright 2018-2023- Swiss Data Science Center (SDSC)
4-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
53
# Eidgenössische Technische Hochschule Zürich (ETHZ).
64
#
75
# Licensed under the Apache License, Version 2.0 (the "License");

‎docs/changes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/cheatsheet/conf.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
# -*- coding: utf-8 -*-
2-
#
3-
# Copyright 2017-2023 - Swiss Data Science Center (SDSC)
4-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
53
# Eidgenössische Technische Hochschule Zürich (ETHZ).
64
#
75
# Licensed under the Apache License, Version 2.0 (the "License");

‎docs/conf.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
# -*- coding: utf-8 -*-
2-
#
3-
# Copyright 2017-2023 - Swiss Data Science Center (SDSC)
4-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
53
# Eidgenössische Technische Hochschule Zürich (ETHZ).
64
#
75
# Licensed under the Apache License, Version 2.0 (the "License");

‎docs/gettingstarted.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:orphan:
22

33
..
4-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
4+
Copyright Swiss Data Science Center (SDSC).
55
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
66
Eidgenössische Technische Hochschule Zürich (ETHZ).
77

‎docs/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/license.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ License
33

44
.. code-block:: text
55
6-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
6+
Copyright Swiss Data Science Center (SDSC).
77
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
88
Eidgenössische Technische Hochschule Zürich (ETHZ).
99

‎docs/plugins.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/commands/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/core.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/database.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/gateways.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/models/dataset_provider.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/models/datasets.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/models/projects.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/models/provenance.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/models/workflow.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/plugins.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/service.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎docs/reference/service_errors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
..
2-
Copyright 2017-2023 - Swiss Data Science Center (SDSC)
2+
Copyright Swiss Data Science Center (SDSC).
33
A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
44
Eidgenössische Technische Hochschule Zürich (ETHZ).
55

‎pyproject.toml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
# -*- coding: utf-8 -*-
2-
#
3-
# Copyright 2017-2023 - Swiss Data Science Center (SDSC)
4-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
53
# Eidgenössische Technische Hochschule Zürich (ETHZ).
64
#
75
# Licensed under the Apache License, Version 2.0 (the "License");

‎renku/command/__init__.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
#
2-
# Copyright 2017-2023 - Swiss Data Science Center (SDSC)
3-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
43
# Eidgenössische Technische Hochschule Zürich (ETHZ).
54
#
65
# Licensed under the Apache License, Version 2.0 (the "License");

‎renku/command/checks/datasets.py

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,17 @@ def check_missing_files(dataset_gateway: IDatasetGateway, **_):
7777
path = project_context.path / file_.entity.path
7878
file_exists = path.exists() or (file_.is_external and os.path.lexists(path))
7979
if not file_exists:
80-
missing[dataset.name].append(file_.entity.path)
80+
missing[dataset.slug].append(file_.entity.path)
8181

8282
if not missing:
8383
return True, False, None
8484

8585
problems = WARNING + "There are missing files in datasets."
8686

87-
for dataset_name, files in missing.items():
87+
for dataset_slug, files in missing.items():
8888
problems += (
8989
"\n\t"
90-
+ click.style(dataset_name, fg="yellow")
90+
+ click.style(dataset_slug, fg="yellow")
9191
+ ":\n\t "
9292
+ "\n\t ".join(click.style(path, fg="red") for path in files)
9393
)
@@ -114,9 +114,9 @@ def fix_or_report(dataset):
114114
dataset.unfreeze()
115115
dataset.derived_from = None
116116
dataset.freeze()
117-
communication.info(f"Fixing dataset '{dataset.name}'")
117+
communication.info(f"Fixing dataset '{dataset.slug}'")
118118
else:
119-
invalid_datasets.append(dataset.name)
119+
invalid_datasets.append(dataset.slug)
120120

121121
for dataset in dataset_gateway.get_provenance_tails():
122122
while dataset.derived_from is not None and dataset.derived_from.url_id is not None:
@@ -137,7 +137,7 @@ def fix_or_report(dataset):
137137
WARNING
138138
+ "There are invalid dataset metadata in the project (use 'renku doctor --fix' to fix them):"
139139
+ "\n\n\t"
140-
+ "\n\t".join(click.style(name, fg="yellow") for name in invalid_datasets)
140+
+ "\n\t".join(click.style(slug, fg="yellow") for slug in invalid_datasets)
141141
+ "\n"
142142
)
143143

@@ -177,12 +177,12 @@ def check_dataset_files_outside_datadir(fix, dataset_gateway: IDatasetGateway, *
177177
continue
178178

179179
if fix:
180-
communication.info(f"Fixing dataset '{dataset.name}' files.")
180+
communication.info(f"Fixing dataset '{dataset.slug}' files.")
181181
dataset.unfreeze()
182182
for file in detected_files:
183183
dataset.unlink_file(file.entity.path)
184184
dataset.freeze()
185-
add_to_dataset(dataset.name, urls=[file.entity.path for file in detected_files], link=True)
185+
add_to_dataset(dataset.slug, urls=[file.entity.path for file in detected_files], link=True)
186186
else:
187187
invalid_files.extend(detected_files)
188188

@@ -220,7 +220,7 @@ def check_external_files(fix, dataset_gateway: IDatasetGateway, **_):
220220
for file in dataset.files:
221221
if file.is_external:
222222
external_files.append(file.entity.path)
223-
datasets[dataset.name].append(file)
223+
datasets[dataset.slug].append(file)
224224

225225
if not external_files:
226226
return True, False, None
@@ -240,7 +240,7 @@ def check_external_files(fix, dataset_gateway: IDatasetGateway, **_):
240240
f"dataset with an external storage backend:\n\t{external_files_str}"
241241
)
242242

243-
for name, files in datasets.items():
244-
file_unlink(name=name, yes=True, dataset_files=files)
243+
for slug, files in datasets.items():
244+
file_unlink(slug=slug, yes=True, dataset_files=files)
245245

246246
return True, False, None

‎renku/command/checks/validate_shacl.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,15 @@ def check_datasets_structure(dataset_gateway: IDatasetGateway, **_):
104104
try:
105105
conform, graph, t = _check_shacl_structure(data)
106106
except (Exception, BaseException) as e:
107-
problems.append(f"Couldn't validate dataset '{dataset.name}': {e}\n\n")
107+
problems.append(f"Couldn't validate dataset '{dataset.slug}': {e}\n\n")
108108
continue
109109

110110
if conform:
111111
continue
112112

113113
ok = False
114114

115-
problems.append(f"{dataset.name}\n\t{_shacl_graph_to_string(graph)}\n")
115+
problems.append(f"{dataset.slug}\n\t{_shacl_graph_to_string(graph)}\n")
116116

117117
if ok:
118118
return True, False, None

‎renku/command/clone.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
#
2-
# Copyright 2018-2023- Swiss Data Science Center (SDSC)
3-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
43
# Eidgenössische Technische Hochschule Zürich (ETHZ).
54
#
65
# Licensed under the Apache License, Version 2.0 (the "License");

‎renku/command/config.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
#
2-
# Copyright 2017-2023 - Swiss Data Science Center (SDSC)
3-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
43
# Eidgenössische Technische Hochschule Zürich (ETHZ).
54
#
65
# Licensed under the Apache License, Version 2.0 (the "License");

‎renku/command/dataset.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
#
2-
# Copyright 2017-2023 - Swiss Data Science Center (SDSC)
3-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
43
# Eidgenössische Technische Hochschule Zürich (ETHZ).
54
#
65
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,7 +38,7 @@
3938

4039

4140
def search_datasets_command():
42-
"""Command to get all the datasets whose name starts with the given string."""
41+
"""Command to get all the datasets whose slug starts with the given string."""
4342
return Command().command(search_datasets).require_migration().with_database()
4443

4544

‎renku/command/doctor.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
#
2-
# Copyright 2020 - Swiss Data Science Center (SDSC)
3-
# A partnership between École Polytechnique Fédérale de Lausanne (EPFL) and
1+
# Copyright Swiss Data Science Center (SDSC). A partnership between
2+
# École Polytechnique Fédérale de Lausanne (EPFL) and
43
# Eidgenössische Technische Hochschule Zürich (ETHZ).
54
#
65
# Licensed under the Apache License, Version 2.0 (the "License");

‎renku/command/format/dataset_files.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,10 @@ def get_lfs_tracking():
7373
record.is_lfs = False
7474

7575
def naturalize(value) -> str:
76-
return naturalsize(value).upper().replace("BYTES", " B")
76+
try:
77+
return naturalsize(value).upper().replace("BYTES", " B")
78+
except ValueError:
79+
return str(value)
7780

7881
def get_file_sizes():
7982
if not any(r for r in records if r.size is None): # All records already have a size
@@ -181,8 +184,8 @@ def json(records, **_):
181184
"dataset": ("title", "dataset"),
182185
"full_path": ("full_path", None),
183186
"path": ("path", None),
184-
"short_name": ("dataset_name", "dataset name"),
185-
"dataset_name": ("dataset_name", "dataset name"),
187+
"short_name": ("dataset_slug", "dataset slug"),
188+
"dataset_slug": ("dataset_slug", "dataset slug"),
186189
"size": ("size", None),
187190
"lfs": ("is_lfs", "lfs"),
188191
"source": ("source", None),

0 commit comments

Comments
 (0)