mirror of
https://github.com/Garmelon/PFERD.git
synced 2023-12-21 10:23:01 +01:00
Added alias functionality
This commit is contained in:
parent
d6f38a61e1
commit
9e12e96d90
@ -86,6 +86,9 @@ common to all crawlers:
|
|||||||
load for the crawl target. (Default: `0.0`)
|
load for the crawl target. (Default: `0.0`)
|
||||||
- `windows_paths`: Whether PFERD should find alternative names for paths that
|
- `windows_paths`: Whether PFERD should find alternative names for paths that
|
||||||
are invalid on Windows. (Default: `yes` on Windows, `no` otherwise)
|
are invalid on Windows. (Default: `yes` on Windows, `no` otherwise)
|
||||||
|
- `alias`: List of strings that are considered as an alias when invoking with
|
||||||
|
the `--crawler` or `-C` flag. If there is more then one crawl section with
|
||||||
|
the same alias all are selected. Thereby you can group different crawlers.
|
||||||
|
|
||||||
Some crawlers may also require credentials for authentication. To configure how
|
Some crawlers may also require credentials for authentication. To configure how
|
||||||
the crawler obtains its credentials, the `auth` option is used. It is set to the
|
the crawler obtains its credentials, the `auth` option is used. It is set to the
|
||||||
@ -100,6 +103,7 @@ username = foo
|
|||||||
password = bar
|
password = bar
|
||||||
|
|
||||||
[crawl:something]
|
[crawl:something]
|
||||||
|
alias = [sth, some]
|
||||||
type = some-complex-crawler
|
type = some-complex-crawler
|
||||||
auth = auth:example
|
auth = auth:example
|
||||||
on_conflict = no-delete
|
on_conflict = no-delete
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Dict, List, Optional
|
from typing import Dict, List, Optional, Set
|
||||||
|
|
||||||
from rich.markup import escape
|
from rich.markup import escape
|
||||||
|
|
||||||
@ -43,16 +43,22 @@ class Pferd:
|
|||||||
|
|
||||||
crawl_sections = [name for name, _ in config.crawl_sections()]
|
crawl_sections = [name for name, _ in config.crawl_sections()]
|
||||||
|
|
||||||
crawlers_to_run = [] # With crawl: prefix
|
crawlers_to_run = set() # With crawl: prefix
|
||||||
unknown_names = [] # Without crawl: prefix
|
unknown_names = [] # Without crawl: prefix
|
||||||
|
|
||||||
for name in cli_crawlers:
|
for name in cli_crawlers:
|
||||||
section_name = f"crawl:{name}"
|
section_name = f"crawl:{name}"
|
||||||
if section_name in crawl_sections:
|
if section_name in crawl_sections:
|
||||||
log.explain(f"Crawler section named {section_name!r} exists")
|
log.explain(f"Crawler section named {section_name!r} exists")
|
||||||
crawlers_to_run.append(section_name)
|
crawlers_to_run.add(section_name)
|
||||||
else:
|
alias_names = self._find_crawlers_by_alias(name, config)
|
||||||
log.explain(f"There's no crawler section named {section_name!r}")
|
if alias_names:
|
||||||
|
crawlers_to_run.update(alias_names)
|
||||||
|
log.explain_topic(f"Crawler alias {name!r} found corresponding crawler sections:")
|
||||||
|
for alias_name in alias_names:
|
||||||
|
log.explain(f"Crawler section named {alias_name!r} with alias {name!r} exists")
|
||||||
|
if not section_name in crawl_sections and not alias_names:
|
||||||
|
log.explain(f"There's neither a crawler section named {section_name!r} nor does a crawler with alias {name!r} exist.")
|
||||||
unknown_names.append(name)
|
unknown_names.append(name)
|
||||||
|
|
||||||
if unknown_names:
|
if unknown_names:
|
||||||
@ -65,6 +71,14 @@ class Pferd:
|
|||||||
|
|
||||||
return crawlers_to_run
|
return crawlers_to_run
|
||||||
|
|
||||||
|
def _find_crawlers_by_alias(self, alias: str, config: Config) -> Set[str]:
|
||||||
|
alias_names = set()
|
||||||
|
for (section_name, section) in config.crawl_sections():
|
||||||
|
section_alias = section.get("alias", [])
|
||||||
|
if alias in section_alias:
|
||||||
|
alias_names.add(section_name)
|
||||||
|
return alias_names
|
||||||
|
|
||||||
def _find_crawlers_to_run(
|
def _find_crawlers_to_run(
|
||||||
self,
|
self,
|
||||||
config: Config,
|
config: Config,
|
||||||
|
Loading…
Reference in New Issue
Block a user