polishment

Author: vdusek

docs/02_guides/05_scrapy.mdx

@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
 import UnderscoreMainExample from '!!raw-loader!./code/scrapy_project/src/__main__.py';
 import MainExample from '!!raw-loader!./code/scrapy_project/src/main.py';
 import ItemsExample from '!!raw-loader!./code/scrapy_project/src/items.py';
-import SpidersExample from '!!raw-loader!./code/scrapy_project/src/spiders.py';
+import SpidersExample from '!!raw-loader!./code/scrapy_project/src/spiders/title.py';
 import SettingsExample from '!!raw-loader!./code/scrapy_project/src/settings.py';
 
 [Scrapy](https://scrapy.org/) is an open-source web scraping framework for Python. It provides tools for defining scrapers, extracting data from web pages, following links, and handling pagination. With the Apify SDK, Scrapy projects can be converted into Apify [Actors](https://docs.apify.com/platform/actors), integrated with Apify [storages](https://docs.apify.com/platform/storage), and executed on the Apify [platform](https://docs.apify.com/platform).
@@ -75,19 +75,19 @@ The following example demonstrates a Scrapy Actor that scrapes page titles and e
             {MainExample}
         </CodeBlock>
     </TabItem>
-    <TabItem value="items.py" label="items.py">
+    <TabItem value="settings.py" label="settings.py">
         <CodeBlock className="language-python">
-            {ItemsExample}
+            {SettingsExample}
         </CodeBlock>
     </TabItem>
-    <TabItem value="spiders.py" label="spiders.py">
+    <TabItem value="items.py" label="items.py">
         <CodeBlock className="language-python">
-            {SpidersExample}
+            {ItemsExample}
         </CodeBlock>
     </TabItem>
-    <TabItem value="settings.py" label="settings.py">
+    <TabItem value="spiders/title.py" label="spiders/title.py">
         <CodeBlock className="language-python">
-            {SettingsExample}
+            {SpidersExample}
         </CodeBlock>
     </TabItem>
 </Tabs>

docs/02_guides/code/scrapy_project/src/spiders/__init__.py

@@ -0,0 +1 @@
+from .title import TitleSpider

docs/02_guides/code/scrapy_project/src/spiders/py.typed

@@ -5,7 +5,7 @@
 
 from scrapy import Request, Spider
 
-from .items import TitleItem
+from ..items import TitleItem
 
 if TYPE_CHECKING:
     from collections.abc import Generator

docs/02_guides/code/scrapy_project/src/spiders.py renamed to docs/02_guides/code/scrapy_project/src/spiders/title.py

@@ -145,6 +145,8 @@ indent-style = "space"
     "I001",  # Import block is un-sorted or un-formatted
     # Class variables are common in Scrapy projects.
     "RUF012",  # Mutable class attributes should be annotated with `typing.ClassVar`
+    # Local imports in Scrapy project.
+    "TID252",  # Prefer absolute imports over relative imports from parent modules
 ]
 
 [tool.ruff.lint.flake8-quotes]

pyproject.toml

@@ -13,12 +13,13 @@ async def test_actor_scrapy_title_spider(
     run_actor: RunActorFunction,
 ) -> None:
     actor_source_files = {
-        'src/spiders.py': read_file('docs/02_guides/code/scrapy_project/src/spiders.py'),
-        'src/items.py': read_file('docs/02_guides/code/scrapy_project/src/items.py'),
-        'src/settings.py': read_file('docs/02_guides/code/scrapy_project/src/settings.py'),
         'src/__init__.py': read_file('docs/02_guides/code/scrapy_project/src/__init__.py'),
-        'src/main.py': read_file('docs/02_guides/code/scrapy_project/src/main.py'),
         'src/__main__.py': read_file('docs/02_guides/code/scrapy_project/src/__main__.py'),
+        'src/items.py': read_file('docs/02_guides/code/scrapy_project/src/items.py'),
+        'src/main.py': read_file('docs/02_guides/code/scrapy_project/src/main.py'),
+        'src/settings.py': read_file('docs/02_guides/code/scrapy_project/src/settings.py'),
+        'src/spiders/__init__.py': read_file('docs/02_guides/code/scrapy_project/src/spiders/__init__.py'),
+        'src/spiders/title.py': read_file('docs/02_guides/code/scrapy_project/src/spiders/title.py'),
     }
 
     actor = await make_actor('actor-scrapy-title-spider', source_files=actor_source_files)