Move copyright and license as code comments

llucax · llucax · commit 76b6b7960caa · 2022-11-03T15:36:16.000+01:00
When generating the documentation, the License and Copyright text
appears on every module. It might be confusing for users if the license
applies to the code or the documentation.

This commit just moves the copyright notice and license specification as
a regular comment instead of putting it into the docstring that gets
rendered as documentation.

This was automatically adjusted using:

```sh
find -name '*.py' -not -path './.*' \
	| xargs sed -i '1 i\# License: MIT\n# Copyright © 2022 Frequenz Energy-as-a-Service GmbH\n'
find -name '*.py' -not -path './.*' \
	| xargs sed -zi 's/\n\?\(Copyright\|License\)\n[^\n]*\n\n\?//g'
```

Signed-off-by: Leandro Lucarella &lt;leandro.lucarella@frequenz.com&gt;
diff --git a/benchmarks/benchmark_anycast.py b/benchmarks/benchmark_anycast.py
@@ -1,11 +1,7 @@
-"""Benchmark for Anycast channels.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Benchmark for Anycast channels."""
 
 import asyncio
 import csv
diff --git a/benchmarks/benchmark_broadcast.py b/benchmarks/benchmark_broadcast.py
@@ -1,11 +1,7 @@
-"""Benchmark for Broadcast channels.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Benchmark for Broadcast channels."""
 
 import asyncio
 import csv
diff --git a/noxfile.py b/noxfile.py
@@ -1,11 +1,7 @@
-"""Code quality checks.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Code quality checks."""
 
 import nox
 
diff --git a/src/frequenz/channels/__init__.py b/src/frequenz/channels/__init__.py
@@ -1,11 +1,7 @@
-"""Channel implementations.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Channel implementations."""
 
 from frequenz.channels.anycast import Anycast
 from frequenz.channels.base_classes import BufferedReceiver, Peekable, Receiver, Sender
diff --git a/src/frequenz/channels/anycast.py b/src/frequenz/channels/anycast.py
@@ -1,11 +1,7 @@
-"""A channel for sending data across async tasks.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""A channel for sending data across async tasks."""
 
 from asyncio import Condition
 from collections import deque
diff --git a/src/frequenz/channels/base_classes.py b/src/frequenz/channels/base_classes.py
@@ -1,12 +1,7 @@
-"""
-Baseclasses for Channel Sender and Receiver.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Baseclasses for Channel Sender and Receiver."""
 
 from abc import ABC, abstractmethod
 from typing import Callable, Generic, Optional, TypeVar
diff --git a/src/frequenz/channels/bidirectional.py b/src/frequenz/channels/bidirectional.py
@@ -1,11 +1,7 @@
-"""An abstraction to provide bi-directional communication between actors.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""An abstraction to provide bi-directional communication between actors."""
 
 from typing import Generic, Optional
 
diff --git a/src/frequenz/channels/broadcast.py b/src/frequenz/channels/broadcast.py
@@ -1,11 +1,7 @@
-"""A channel to broadcast messages to all receivers.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""A channel to broadcast messages to all receivers."""
 
 import logging
 from asyncio import Condition
diff --git a/src/frequenz/channels/merge.py b/src/frequenz/channels/merge.py
@@ -1,11 +1,7 @@
-"""Merge messages coming from channels into a single stream.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Merge messages coming from channels into a single stream."""
 
 import asyncio
 from collections import deque
diff --git a/src/frequenz/channels/merge_named.py b/src/frequenz/channels/merge_named.py
@@ -1,11 +1,7 @@
-"""Merge messages coming from channels into a single stream containing name of message.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Merge messages coming from channels into a single stream containing name of message."""
 
 import asyncio
 from collections import deque
diff --git a/src/frequenz/channels/select.py b/src/frequenz/channels/select.py
@@ -1,14 +1,11 @@
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
+
 """Select the first among multiple AsyncIterators.
 
 Expects AsyncIterator class to raise `StopAsyncIteration`
 exception once no more messages are expected or the channel
 is closed in case of `Receiver` class.
-
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
 """
 
 import asyncio
diff --git a/src/frequenz/channels/utils/__init__.py b/src/frequenz/channels/utils/__init__.py
@@ -1,8 +1,4 @@
-"""Channel utilities.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Channel utilities."""
diff --git a/src/frequenz/channels/utils/file_watcher.py b/src/frequenz/channels/utils/file_watcher.py
@@ -1,11 +1,7 @@
-"""A Channel receiver for watching for new (or modified) files.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""A Channel receiver for watching for new (or modified) files."""
 import asyncio
 import pathlib
 from enum import Enum
diff --git a/src/frequenz/channels/utils/timer.py b/src/frequenz/channels/utils/timer.py
@@ -1,11 +1,7 @@
-"""A timer receiver that returns the timestamp every `interval`.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""A timer receiver that returns the timestamp every `interval`."""
 
 import asyncio
 from datetime import datetime, timedelta
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -1,9 +1,4 @@
-"""
-Tests for channels.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Tests for channels."""
diff --git a/tests/test_anycast.py b/tests/test_anycast.py
@@ -1,11 +1,7 @@
-"""Tests for the Channel implementation.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Tests for the Channel implementation."""
 
 import asyncio
 
diff --git a/tests/test_bidirectional.py b/tests/test_bidirectional.py
@@ -1,11 +1,7 @@
-"""Tests for the RequestResponse implementation.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Tests for the RequestResponse implementation."""
 
 import asyncio
 
diff --git a/tests/test_broadcast.py b/tests/test_broadcast.py
@@ -1,11 +1,7 @@
-"""Tests for the Broadcast implementation.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Tests for the Broadcast implementation."""
 
 import asyncio
 from typing import Tuple
diff --git a/tests/test_merge.py b/tests/test_merge.py
@@ -1,11 +1,7 @@
-"""Tests for the Merge implementation.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Tests for the Merge implementation."""
 
 import asyncio
 from typing import List
diff --git a/tests/test_mergenamed.py b/tests/test_mergenamed.py
@@ -1,11 +1,8 @@
-"""Tests for the MergeNamed implementation.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
+"""Tests for the MergeNamed implementation."""
 
-License
-MIT
-"""
 import asyncio
 from typing import List, Tuple
 
diff --git a/tests/test_select.py b/tests/test_select.py
@@ -1,11 +1,8 @@
-"""Tests for the Select implementation.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
+"""Tests for the Select implementation."""
 
-License
-MIT
-"""
 import asyncio
 from asyncio import Queue
 from typing import List, Optional
diff --git a/tests/utils/__init__.py b/tests/utils/__init__.py
@@ -1,9 +1,4 @@
-"""
-Tests for channel utils.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Tests for channel utils."""
diff --git a/tests/utils/test_file_watcher.py b/tests/utils/test_file_watcher.py
@@ -1,11 +1,8 @@
-"""Tests for `channel.FileWatcher`
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
+"""Tests for `channel.FileWatcher`."""
 
-License
-MIT
-"""
 import os
 import pathlib
 
diff --git a/tests/utils/test_timer.py b/tests/utils/test_timer.py
@@ -1,11 +1,7 @@
-"""Tests for `channel.Timer`.
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
 
-Copyright
-Copyright © 2022 Frequenz Energy-as-a-Service GmbH
-
-License
-MIT
-"""
+"""Tests for `channel.Timer`."""
 
 import asyncio
 import logging
