Merge pull request #137 from PROCOLLAB-github/feature/fix-code-format

Add/edit docstrings

Author: Pichcher

chats/consumers/chat.py

@@ -52,9 +52,9 @@ async def connect(self):
         async for project_id in project_ids_list:
             # FIXME: if a user is a leader but not a collaborator, this doesn't work
             #  upd: it seems not possible to be a leader without being a collaborator
-            # join room for each project
-            # It's currently not possible to do this in a single call,
-            #  so we have to do it in a loop (e.g. that's O(N) calls to layer backend, redis cache that would be)
+            # join room for each project -
+            # It's currently not possible to do this in a single call, -
+            #  so we have to do it in a loop (e.g. that's O(N) calls to layer backend, redis cache that would be) -
             await self.channel_layer.group_add(
                 f"{EventGroupType.CHATS_RELATED}_{project_id}", self.channel_name
             )

chats/tests/test_direct.py

@@ -8,6 +8,7 @@
 
 
 class DirectTests(TestCase):
+    """Direct tests for chats"""
     @classmethod
     def setUpTestData(cls):
         user = get_user_model().objects.create(**TEST_USER1)
@@ -21,7 +22,7 @@ async def test_connect_with_crutch(self):
 
     async def test_send_new_message_direct_with_myself(
         self,
-    ):  # Сообщения в чат с самим собой
+    ):  # Chat messages with yourself
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = self.user
         connected, subprotocol = await communicator.connect()
@@ -41,15 +42,15 @@ async def test_send_new_message_direct_with_myself(
         self.assertFalse("error" in response.keys())
         content = response["content"]
         message = content["message"]
-        # Проверка input == output
+        # Checking input == output
         self.assertEqual(response["type"], data["type"])
         self.assertEqual(data["content"]["chat_id"], content["chat_id"])
         self.assertEqual(data["content"]["text"], message["text"])
         self.assertEqual(data["content"]["reply_to"], message["reply_to"])
         self.assertEqual(data["content"]["is_edited"], message["is_edited"])
         self.assertFalse(message["is_deleted"])
 
-    async def test_send_new_message_to_orher_chat(self):  # Сообщение в чужой чат
+    async def test_send_new_message_to_orher_chat(self):  # Message in someone else's chat
         await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         user = await sync_to_async(get_user_model().objects.create)(**TEST_USER3)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
@@ -72,7 +73,7 @@ async def test_send_new_message_to_orher_chat(self):  # Сообщение в ч
 
     async def test_is_edited_new_message_direct_with_myself(
         self,
-    ):  # Проверка на редактированность нового сообщения
+    ):  # Checking if a new message has been edited
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = self.user
         connected, subprotocol = await communicator.connect()
@@ -92,7 +93,7 @@ async def test_is_edited_new_message_direct_with_myself(
         message = response["content"]["message"]
         self.assertTrue(message["is_edited"] != data["content"]["is_edited"])
 
-    async def test_new_message_with_two_users(self):  # Чат на двоих новое сообщение
+    async def test_new_message_with_two_users(self):  # New message for private messages
         await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = self.user
@@ -114,7 +115,7 @@ async def test_new_message_with_two_users(self):  # Чат на двоих но
 
     async def test_read_message_with_new_user(
         self,
-    ):  # Чтение чужих сообщений в своём чате
+    ):  # Reading other people's messages in your chat
         user = await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = user
@@ -154,7 +155,7 @@ async def test_read_message_with_new_user(
         self.assertFalse("error" in response.keys())
         self.assertTrue(direct_message.is_read)
 
-    async def test_read_message_with_myself(self):  # Чтение своих сообщений
+    async def test_read_message_with_myself(self):
         user = await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = user
@@ -191,7 +192,7 @@ async def test_read_message_with_myself(self):  # Чтение своих соо
 
     async def test_read_someone_elses_message(
         self,
-    ):  # Чтение чужих сообщение в чужом чате
+    ):  # Reading someone else's message in someone else's chat
         await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         user = await sync_to_async(get_user_model().objects.create)(**TEST_USER3)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
@@ -232,7 +233,7 @@ async def test_read_someone_elses_message(
         self.assertTrue("error" in response.keys())
         self.assertFalse(direct_message.is_read)
 
-    async def test_edit_my_message_in_myself(self):  # Редактирование в чате с самим собой
+    async def test_edit_my_message_in_myself(self):
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = self.user
         connected, subprotocol = await communicator.connect()
@@ -267,7 +268,7 @@ async def test_edit_my_message_in_myself(self):  # Редактирование
         self.assertTrue(direct_message.is_edited)
         self.assertEqual(direct_message.text, text)
 
-    async def test_edit_my_message(self):  # Редактирование в чате с кем-то
+    async def test_edit_my_message(self):  # Editing while chatting with someone
         await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = self.user
@@ -305,7 +306,7 @@ async def test_edit_my_message(self):  # Редактирование в чат
 
     async def test_edit_other_message(
         self,
-    ):  # Редактирование чужих сообщений в своём чате
+    ):  # Editing other people's messages in your chat
         user = await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = self.user
@@ -348,7 +349,7 @@ async def test_edit_other_message(
 
     async def test_edit_other_message_in_other_char(
         self,
-    ):  # Редактирование чужих сообщений в чужом чате
+    ):
         await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         user = await sync_to_async(get_user_model().objects.create)(**TEST_USER3)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
@@ -393,7 +394,7 @@ async def test_edit_other_message_in_other_char(
 
     async def test_delete_message_in_myself(
         self,
-    ):  # Удаление сообщений в чате с самим собой
+    ):
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = self.user
         connected, subprotocol = await communicator.connect()
@@ -425,7 +426,7 @@ async def test_delete_message_in_myself(
         direct_message = await sync_to_async(DirectChatMessage.objects.get)(id=1)
         self.assertTrue(direct_message.is_deleted)
 
-    async def test_delete_message(self):  # Удаление сообщений в чате с кем-то
+    async def test_delete_message(self):  # Delete messages in a chat with someone
         await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = self.user
@@ -458,7 +459,7 @@ async def test_delete_message(self):  # Удаление сообщений в 
         direct_message = await sync_to_async(DirectChatMessage.objects.get)(id=1)
         self.assertTrue(direct_message.is_deleted)
 
-    async def test_delete_other_message(self):  # Удаление чужих сообщений в чате с кем-то
+    async def test_delete_other_message(self):  # Delete someone else's messages in a chat with someone
         user = await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")
         communicator.scope["user"] = self.user
@@ -498,7 +499,7 @@ async def test_delete_other_message(self):  # Удаление чужих соо
 
     async def test_delete_other_message_in_other_chat(
         self,
-    ):  # Удаление чужих сообщений в чужом чате
+    ):  # Deleting someone else's messages in someone else's chat
         await sync_to_async(get_user_model().objects.create)(**TEST_USER2)
         user = await sync_to_async(get_user_model().objects.create)(**TEST_USER3)
         communicator = WebsocketCommunicator(ChatConsumer.as_asgi(), "/ws/chat/")

chats/tests/test_project.py

@@ -5,7 +5,7 @@
 from chats.consumers import ChatConsumer
 from asgiref.sync import sync_to_async
 
-# from chats.tests.helpres import chat_connect
+# from chats.tests.helpres import chat_connect -
 from projects.models import Project, Collaborator
 from chats.models import ProjectChat, ProjectChatMessage
 from chats.websockets_settings import EventType

chats/utils.py

@@ -17,15 +17,15 @@
 
 def clean_message_text(text: str) -> str:
     """
-    Cleans message text.
+    Cleans message text. -
     """
 
     return text.strip()
 
 
 def validate_message_text(text: str) -> bool:
     """
-    Validates message text.
+    Validates message text. -
     """
     # TODO: add bad word filter
     return 0 < len(text) <= 8192
@@ -118,7 +118,7 @@ async def match_files_and_messages(file_urls, messages):
 
 
 def get_all_files(messages):
-    # looks like something bad
+    # looks like something bad -
     files = []
     for message in messages:
         if hasattr(message, "file_to_message"):

chats/views.py

@@ -67,7 +67,7 @@ def get(self, request, *args, **kwargs) -> Response:
             data = DirectChatDetailSerializer(DirectChat.get_chat(user1, user2)).data
 
             if user1 == request.user:
-                # may be is better to use serializer or return dict
+                # may be is better to use serializer or return dict -
                 # {"first_name": user2.first_name, "last_name": user2.last_name}
                 data["name"] = f"{user2.first_name} {user2.last_name}"
                 data["image_address"] = user2.avatar

events/models.py

@@ -44,7 +44,7 @@ class Event(models.Model):
     favorites = models.ManyToManyField(User, blank=True, related_name="favorites")
     registered_users = models.ManyToManyField(User, blank=True, related_name="events")
     views = models.BigIntegerField(default=0, editable=False)
-    # likes = models.ManyToManyField(User, blank=True, related_name="likes", editable=False)
+    # likes = models.ManyToManyField(User, blank=True, related_name="likes", editable=False) -
 
     tags = TaggableManager()
 

events/signals.py

@@ -16,11 +16,11 @@ def autoposting_receiver(sender, instance, created, *args, **kwargs):
             if response["ok"]:
                 instance.tg_message_id = response["result"]["message_id"]
                 instance.save()
-            # print(response)
+            # print(response) -
         else:
             link = f"{APP_URL}/{instance.pk}"
             text = f"***{instance.title}***\n{instance.short_text}\n\n{link}"
             response = edit_message(
                 text, instance.tg_message_id, settings.TELEGRAM_CHANNEL
             )
-            # print(response)
+            # print(response) -

industries/tests.py

@@ -9,6 +9,7 @@
 
 
 class IndustryTestCase(TestCase):
+    """Tests for industries+"""
     def setUp(self):
         self.factory = APIRequestFactory()
 

news/views.py

@@ -24,7 +24,7 @@ class NewsDetail(generics.RetrieveUpdateDestroyAPIView):
 class NewsTagList(generics.ListAPIView):
     queryset = NewsTag.objects.all()
     serializer_class = NewsTagSerializer
-    # no permission classes listed since the thing is always read-only
+    # no permission classes listed since the thing is always read-only -
 
 
 class NewsTagDetail(generics.RetrieveAPIView):

projects/managers.py

@@ -36,7 +36,7 @@ def get_projects_for_list_view(self):
                 # Or override the default QuerySet to always ask the DB only count after all the filters.
                 # (ticket referring to the reason why you can't
                 # prefetch N items easily https://code.djangoproject.com/ticket/26780)
-                # (seems like in django 4.2.0 it'll be fixed but at the time of writing the latest version is 4.1.3
+                # (seems like in django 4.2.0 it'll be fixed but at the time of writing the latest version is 4.1.3 -
                 Prefetch("collaborator_set"),
             )
         )