@@ -248,6 +248,32 @@ def find_package_dir(
248248 return matching_dirs [0 ]
249249
250250
251+ def find_first_package_dir (
252+ package_or_script_name : str , search_paths : List [Path ] = None
253+ ) -> Optional [Path ]:
254+ """searches the search_paths in order and returns the first match
255+
256+ Unlike find_package_dir, which searches all paths at once and rejects a
257+ name that exists in more than one of them, this prefers the earlier path.
258+ Returns None if no search path holds the name. A path holding more than one
259+ match is ambiguous on its own, so it is skipped with a warning.
260+ """
261+ if search_paths is None :
262+ search_paths = []
263+ for search_path in search_paths :
264+ try :
265+ return find_package_dir (package_or_script_name , [search_path ])
266+ except FileNotFoundError :
267+ # expected: not every search path holds every package
268+ continue
269+ except ValueError as e :
270+ warn (
271+ f"Multiple elements { package_or_script_name }
272+ f"{ search_path } { e }
273+ )
274+ return None
275+
276+
251277def get_listed_pages_from_package_info (package_info : Union [dict , Path ]) -> List [str ]:
252278 """Takes in the output of read_package_info_file and returns a list of
253279 pages listed in the package"""
@@ -663,35 +689,58 @@ def recursive(
663689 if params .read_listed_pages_from_script :
664690 search_paths = [params .script_dir ]
665691 search_paths .extend (params .additional_script_dirs )
666- try :
667- script_path = find_package_dir (
668- f"{ package_to_process } , search_paths
669- )
670- package_script = read_package_script_file (script_path )
671- new_listed_pages = get_listed_pages_from_package_script (
672- package_script
673- )
674- required_packages = get_required_packages_from_package_script (
675- package_script
692+ # Prefer the script in script_dir over the additional dirs,
693+ # instead of failing on a script present in several.
694+ script_path = find_first_package_dir (
695+ f"{ package_to_process } , search_paths
696+ )
697+ new_listed_pages = []
698+ required_packages = []
699+ if script_path is None :
700+ warn (
701+ f"Package script for { package_to_process }
702+ f"of the search paths: { search_paths }
676703 )
677- except Exception as e :
678- warn (f"Error reading package script for { package_to_process } { e } )
679- new_listed_pages = []
680- required_packages = []
704+ else :
705+ try :
706+ package_script = read_package_script_file (script_path )
707+ new_listed_pages = get_listed_pages_from_package_script (
708+ package_script
709+ )
710+ required_packages = get_required_packages_from_package_script (
711+ package_script
712+ )
713+ except Exception as e :
714+ warn (
715+ f"Error reading package script for "
716+ f"{ package_to_process } { e }
717+ )
681718 else :
682719 search_paths = [params .creation_config .working_dir .parent ]
683720 search_paths .extend (params .additional_package_dirs )
684- try :
685- package_dir = find_package_dir (package_to_process , search_paths )
686- package_info = read_package_info_file (package_dir )
687- new_listed_pages = get_listed_pages_from_package_info (package_info )
688- required_packages = get_required_packages_from_package_info_file (
689- package_info
721+ # Prefer the package in the working dir over the additional
722+ # dirs, instead of failing on a package present in several.
723+ package_dir = find_first_package_dir (package_to_process , search_paths )
724+ new_listed_pages = []
725+ required_packages = []
726+ if package_dir is None :
727+ warn (
728+ f"Package info for { package_to_process }
729+ f"of the search paths: { search_paths }
690730 )
691- except Exception as e :
692- warn (f"Error reading package info for { package_to_process } { e } )
693- new_listed_pages = []
694- required_packages = []
731+ else :
732+ try :
733+ package_info = read_package_info_file (package_dir )
734+ new_listed_pages = get_listed_pages_from_package_info (
735+ package_info
736+ )
737+ required_packages = (
738+ get_required_packages_from_package_info_file (package_info )
739+ )
740+ except Exception as e :
741+ warn (
742+ f"Error reading package info for { package_to_process } { e }
743+ )
695744 # Check for redundant pages
696745 for pack_ in listed_pages .keys ():
697746 new_redundant_pages = list (
0 commit comments