Page MenuHomeSoftware Heritage
Differential D5360

Fix consistency of READMEs with existing packages
ClosedPublic
Actions

Authored by vlorentz on Mar 26 2021, 2:45 PM.

Details

Reviewers
ardumont
Group Reviewers
Reviewers
Commits
rDTPL4705a2100b73: Fix consistency of READMEs with existing packages
Summary
  • Swap docs/README.rst and README.rst
  • move index.rst's content to README.rst
  • Also fix the mimetype in setup.py

Replaces D5354

Diff Detail

Repository
rDTPL Python module template
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 20281
Build 31482: Phabricator diff pipeline on jenkins
Build 31481: arc lint + arc unit

Event Timeline

vlorentz created this revision.Mar 26 2021, 2:45 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptMar 26 2021, 2:45 PM
Harbormaster returned this revision to the author for changes because remote builds failed.Mar 26 2021, 2:45 PM
Harbormaster failed remote builds in B20279: Diff 19198!
vlorentz updated this revision to Diff 19199.Mar 26 2021, 2:45 PM

fix commit msg

vlorentz retitled this revision from Swap consistency of READMEs with other modules to Fix consistency of READMEs with existing packages.Mar 26 2021, 2:46 PM
Harbormaster returned this revision to the author for changes because remote builds failed.Mar 26 2021, 2:46 PM
Harbormaster failed remote builds in B20280: Diff 19199!
vlorentz requested review of this revision.Mar 26 2021, 2:46 PM
vlorentz updated this revision to Diff 19201.Mar 26 2021, 2:47 PM

add symlink

Harbormaster failed remote builds in B20281: Diff 19201!Mar 26 2021, 2:47 PM
ardumont requested changes to this revision.Mar 26 2021, 3:09 PM
ardumont added a subscriber: ardumont.
ardumont added inline comments.
docs/README.rst
1

We settled on the other way around [1]

/README.rst -> /docs/README.rst

[1] https://hedgedoc.softwareheritage.org/EZR2580uS_60pBRft9-sUQ#readmes

This revision now requires changes to proceed.Mar 26 2021, 3:09 PM
vlorentz updated this revision to Diff 19224.Mar 26 2021, 6:03 PM

swap files

Harbormaster failed remote builds in B20306: Diff 19224!Mar 26 2021, 6:03 PM
ardumont accepted this revision.Mar 26 2021, 6:06 PM
This revision is now accepted and ready to land.Mar 26 2021, 6:06 PM
This revision was landed with ongoing or failed builds.Mar 26 2021, 7:11 PM
Closed by commit rDTPL4705a2100b73: Fix consistency of READMEs with existing packages (authored by vlorentz). · Explain Why
This revision was automatically updated to reflect the committed changes.
vlorentz added a commit: rDTPL4705a2100b73: Fix consistency of READMEs with existing packages.

Revision Contents
Changeset List

PathSize
6 lines
docs/
1 line
9 lines
2 lines

Diff 19201

View Options

README.rst

Show All 18 Lines
from swh.core.api import RemoteException from swh.core.api import RemoteException
from swh.core.api.classes import stream_results from swh.core.api.classes import stream_results
from swh.model import from_disk, hypothesis_strategies from swh.model import from_disk, hypothesis_strategies
from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes
from swh.model.model import ( from swh.model.model import (
Content, Content,
Directory, Directory,
DirectoryEntry,
ExtID, ExtID,
Origin, Origin,
OriginVisit, OriginVisit,
OriginVisitStatus, OriginVisitStatus,
Person, Person,
RawExtrinsicMetadata, RawExtrinsicMetadata,
Revision, Revision,
RevisionType, RevisionType,
▲ Show 20 Lines • Show All 764 Lines • ▼ Show 20 Lines def test_directory_add_twice(self, swh_storage, sample_data):
actual_result = swh_storage.directory_add([directory]) actual_result = swh_storage.directory_add([directory])
assert actual_result == {"directory:add": 0} assert actual_result == {"directory:add": 0}
assert list(swh_storage.journal_writer.journal.objects) == [ assert list(swh_storage.journal_writer.journal.objects) == [
("directory", directory) ("directory", directory)
] ]
def test_directory_add_raw_manifest__different_entries(
self, swh_storage, check_ls=True
):
"""Add two directories with the same raw_manifest (and therefore, same id)
but different entries.
"""
dir1 = Directory(
entries=(
DirectoryEntry(
name=b"name1", type="file", target=b"\x00" * 20, perms=0o100000
),
),
raw_manifest=b"abc",
)
dir2 = Directory(
entries=(
DirectoryEntry(
name=b"name2", type="file", target=b"\x00" * 20, perms=0o100000
),
),
raw_manifest=b"abc",
)
assert dir1.id == dir2.id # because it is computed from the raw_manifest only
assert swh_storage.directory_add([dir1])["directory:add"] == 1
ardumontUnsubmitted
Not Done
Inline Actions

maybe mentions it's about different implementations (storage pg: 0, storage cass: 1 if i'm not wrong).

ardumont: maybe mentions it's about different implementations (storage pg: 0, storage cass: 1 if i'm not…
assert swh_storage.directory_add([dir2])["directory:add"] in (0, 1)
if check_ls:
# This assertion is skipped when running from
# test_directory_add_raw_manifest__different_entries__allow_overwrite
assert [entry["name"] for entry in swh_storage.directory_ls(dir1.id)] == (
[b"name1"]
)
# used in TestCassandraStorage by
# test_directory_add_raw_manifest__different_entries__allow_overwrite
return dir1.id
def test_directory_ls_recursive(self, swh_storage, sample_data): def test_directory_ls_recursive(self, swh_storage, sample_data):
# create consistent dataset regarding the directories we want to list # create consistent dataset regarding the directories we want to list
content, content2 = sample_data.contents[:2] content, content2 = sample_data.contents[:2]
swh_storage.content_add([content, content2]) swh_storage.content_add([content, content2])
dir1, dir2, dir3 = sample_data.directories[:3] dir1, dir2, dir3 = sample_data.directories[:3]
dir_ids = [d.id for d in [dir1, dir2, dir3]] dir_ids = [d.id for d in [dir1, dir2, dir3]]
init_missing = list(swh_storage.directory_missing(dir_ids)) init_missing = list(swh_storage.directory_missing(dir_ids))
▲ Show 20 Lines • Show All 4,774 Lines • Show Last 20 Lines
View Options

docs/README.rst

Show All 18 Lines
from swh.core.api import RemoteException from swh.core.api import RemoteException
from swh.core.api.classes import stream_results from swh.core.api.classes import stream_results
from swh.model import from_disk, hypothesis_strategies from swh.model import from_disk, hypothesis_strategies
from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes
from swh.model.model import ( from swh.model.model import (
Content, Content,
Directory, Directory,
DirectoryEntry,
ExtID, ExtID,
Origin, Origin,
OriginVisit, OriginVisit,
OriginVisitStatus, OriginVisitStatus,
Person, Person,
RawExtrinsicMetadata, RawExtrinsicMetadata,
Revision, Revision,
RevisionType, RevisionType,
▲ Show 20 Lines • Show All 764 Lines • ▼ Show 20 Lines def test_directory_add_twice(self, swh_storage, sample_data):
actual_result = swh_storage.directory_add([directory]) actual_result = swh_storage.directory_add([directory])
assert actual_result == {"directory:add": 0} assert actual_result == {"directory:add": 0}
assert list(swh_storage.journal_writer.journal.objects) == [ assert list(swh_storage.journal_writer.journal.objects) == [
("directory", directory) ("directory", directory)
] ]
def test_directory_add_raw_manifest__different_entries(
self, swh_storage, check_ls=True
):
"""Add two directories with the same raw_manifest (and therefore, same id)
but different entries.
"""
dir1 = Directory(
entries=(
DirectoryEntry(
name=b"name1", type="file", target=b"\x00" * 20, perms=0o100000
),
),
raw_manifest=b"abc",
)
dir2 = Directory(
entries=(
DirectoryEntry(
name=b"name2", type="file", target=b"\x00" * 20, perms=0o100000
),
),
raw_manifest=b"abc",
)
assert dir1.id == dir2.id # because it is computed from the raw_manifest only
assert swh_storage.directory_add([dir1])["directory:add"] == 1
ardumontUnsubmitted
Not Done
Inline Actions

maybe mentions it's about different implementations (storage pg: 0, storage cass: 1 if i'm not wrong).

ardumont: maybe mentions it's about different implementations (storage pg: 0, storage cass: 1 if i'm not…
assert swh_storage.directory_add([dir2])["directory:add"] in (0, 1)
if check_ls:
# This assertion is skipped when running from
# test_directory_add_raw_manifest__different_entries__allow_overwrite
assert [entry["name"] for entry in swh_storage.directory_ls(dir1.id)] == (
[b"name1"]
)
# used in TestCassandraStorage by
# test_directory_add_raw_manifest__different_entries__allow_overwrite
return dir1.id
def test_directory_ls_recursive(self, swh_storage, sample_data): def test_directory_ls_recursive(self, swh_storage, sample_data):
# create consistent dataset regarding the directories we want to list # create consistent dataset regarding the directories we want to list
content, content2 = sample_data.contents[:2] content, content2 = sample_data.contents[:2]
swh_storage.content_add([content, content2]) swh_storage.content_add([content, content2])
dir1, dir2, dir3 = sample_data.directories[:3] dir1, dir2, dir3 = sample_data.directories[:3]
dir_ids = [d.id for d in [dir1, dir2, dir3]] dir_ids = [d.id for d in [dir1, dir2, dir3]]
init_missing = list(swh_storage.directory_missing(dir_ids)) init_missing = list(swh_storage.directory_missing(dir_ids))
▲ Show 20 Lines • Show All 4,774 Lines • Show Last 20 Lines
View Options

docs/index.rst

Show All 18 Lines
from swh.core.api import RemoteException from swh.core.api import RemoteException
from swh.core.api.classes import stream_results from swh.core.api.classes import stream_results
from swh.model import from_disk, hypothesis_strategies from swh.model import from_disk, hypothesis_strategies
from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes
from swh.model.model import ( from swh.model.model import (
Content, Content,
Directory, Directory,
DirectoryEntry,
ExtID, ExtID,
Origin, Origin,
OriginVisit, OriginVisit,
OriginVisitStatus, OriginVisitStatus,
Person, Person,
RawExtrinsicMetadata, RawExtrinsicMetadata,
Revision, Revision,
RevisionType, RevisionType,
▲ Show 20 Lines • Show All 764 Lines • ▼ Show 20 Lines def test_directory_add_twice(self, swh_storage, sample_data):
actual_result = swh_storage.directory_add([directory]) actual_result = swh_storage.directory_add([directory])
assert actual_result == {"directory:add": 0} assert actual_result == {"directory:add": 0}
assert list(swh_storage.journal_writer.journal.objects) == [ assert list(swh_storage.journal_writer.journal.objects) == [
("directory", directory) ("directory", directory)
] ]
def test_directory_add_raw_manifest__different_entries(
self, swh_storage, check_ls=True
):
"""Add two directories with the same raw_manifest (and therefore, same id)
but different entries.
"""
dir1 = Directory(
entries=(
DirectoryEntry(
name=b"name1", type="file", target=b"\x00" * 20, perms=0o100000
),
),
raw_manifest=b"abc",
)
dir2 = Directory(
entries=(
DirectoryEntry(
name=b"name2", type="file", target=b"\x00" * 20, perms=0o100000
),
),
raw_manifest=b"abc",
)
assert dir1.id == dir2.id # because it is computed from the raw_manifest only
assert swh_storage.directory_add([dir1])["directory:add"] == 1
ardumontUnsubmitted
Not Done
Inline Actions

maybe mentions it's about different implementations (storage pg: 0, storage cass: 1 if i'm not wrong).

ardumont: maybe mentions it's about different implementations (storage pg: 0, storage cass: 1 if i'm not…
assert swh_storage.directory_add([dir2])["directory:add"] in (0, 1)
if check_ls:
# This assertion is skipped when running from
# test_directory_add_raw_manifest__different_entries__allow_overwrite
assert [entry["name"] for entry in swh_storage.directory_ls(dir1.id)] == (
[b"name1"]
)
# used in TestCassandraStorage by
# test_directory_add_raw_manifest__different_entries__allow_overwrite
return dir1.id
def test_directory_ls_recursive(self, swh_storage, sample_data): def test_directory_ls_recursive(self, swh_storage, sample_data):
# create consistent dataset regarding the directories we want to list # create consistent dataset regarding the directories we want to list
content, content2 = sample_data.contents[:2] content, content2 = sample_data.contents[:2]
swh_storage.content_add([content, content2]) swh_storage.content_add([content, content2])
dir1, dir2, dir3 = sample_data.directories[:3] dir1, dir2, dir3 = sample_data.directories[:3]
dir_ids = [d.id for d in [dir1, dir2, dir3]] dir_ids = [d.id for d in [dir1, dir2, dir3]]
init_missing = list(swh_storage.directory_missing(dir_ids)) init_missing = list(swh_storage.directory_missing(dir_ids))
▲ Show 20 Lines • Show All 4,774 Lines • Show Last 20 Lines
View Options

setup.py

Show All 18 Lines
from swh.core.api import RemoteException from swh.core.api import RemoteException
from swh.core.api.classes import stream_results from swh.core.api.classes import stream_results
from swh.model import from_disk, hypothesis_strategies from swh.model import from_disk, hypothesis_strategies
from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes from swh.model.hashutil import DEFAULT_ALGORITHMS, hash_to_bytes
from swh.model.model import ( from swh.model.model import (
Content, Content,
Directory, Directory,
DirectoryEntry,
ExtID, ExtID,
Origin, Origin,
OriginVisit, OriginVisit,
OriginVisitStatus, OriginVisitStatus,
Person, Person,
RawExtrinsicMetadata, RawExtrinsicMetadata,
Revision, Revision,
RevisionType, RevisionType,
▲ Show 20 Lines • Show All 764 Lines • ▼ Show 20 Lines def test_directory_add_twice(self, swh_storage, sample_data):
actual_result = swh_storage.directory_add([directory]) actual_result = swh_storage.directory_add([directory])
assert actual_result == {"directory:add": 0} assert actual_result == {"directory:add": 0}
assert list(swh_storage.journal_writer.journal.objects) == [ assert list(swh_storage.journal_writer.journal.objects) == [
("directory", directory) ("directory", directory)
] ]
def test_directory_add_raw_manifest__different_entries(
self, swh_storage, check_ls=True
):
"""Add two directories with the same raw_manifest (and therefore, same id)
but different entries.
"""
dir1 = Directory(
entries=(
DirectoryEntry(
name=b"name1", type="file", target=b"\x00" * 20, perms=0o100000
),
),
raw_manifest=b"abc",
)
dir2 = Directory(
entries=(
DirectoryEntry(
name=b"name2", type="file", target=b"\x00" * 20, perms=0o100000
),
),
raw_manifest=b"abc",
)
assert dir1.id == dir2.id # because it is computed from the raw_manifest only
assert swh_storage.directory_add([dir1])["directory:add"] == 1
ardumontUnsubmitted
Not Done
Inline Actions

maybe mentions it's about different implementations (storage pg: 0, storage cass: 1 if i'm not wrong).

ardumont: maybe mentions it's about different implementations (storage pg: 0, storage cass: 1 if i'm not…
assert swh_storage.directory_add([dir2])["directory:add"] in (0, 1)
if check_ls:
# This assertion is skipped when running from
# test_directory_add_raw_manifest__different_entries__allow_overwrite
assert [entry["name"] for entry in swh_storage.directory_ls(dir1.id)] == (
[b"name1"]
)
# used in TestCassandraStorage by
# test_directory_add_raw_manifest__different_entries__allow_overwrite
return dir1.id
def test_directory_ls_recursive(self, swh_storage, sample_data): def test_directory_ls_recursive(self, swh_storage, sample_data):
# create consistent dataset regarding the directories we want to list # create consistent dataset regarding the directories we want to list
content, content2 = sample_data.contents[:2] content, content2 = sample_data.contents[:2]
swh_storage.content_add([content, content2]) swh_storage.content_add([content, content2])
dir1, dir2, dir3 = sample_data.directories[:3] dir1, dir2, dir3 = sample_data.directories[:3]
dir_ids = [d.id for d in [dir1, dir2, dir3]] dir_ids = [d.id for d in [dir1, dir2, dir3]]
init_missing = list(swh_storage.directory_missing(dir_ids)) init_missing = list(swh_storage.directory_missing(dir_ids))
▲ Show 20 Lines • Show All 4,774 Lines • Show Last 20 Lines
About · Developer information · Legal