pkg.ebuild: export DEFINED_PHASES metadata

Author: radhermit

src/pkgcraft/pkg/ebuild.pxd

@@ -17,6 +17,7 @@ cdef class EbuildPkg(Pkg):
     cdef object _required_use
     cdef object _restrict
     cdef object _src_uri
+    cdef frozenset _defined_phases
     cdef tuple _homepage
     cdef tuple _keywords
     cdef tuple _inherit

src/pkgcraft/pkg/ebuild.pyx

@@ -165,6 +165,18 @@ cdef class EbuildPkg(Pkg):
             self._src_uri = None if deps is NULL else DepSet.from_ptr(deps)
         return self._src_uri
 
+    @property
+    def defined_phases(self):
+        """Get a package's defined phases."""
+        cdef char **phases
+        cdef size_t length
+
+        if self._defined_phases is None:
+            phases = C.pkgcraft_ebuild_pkg_defined_phases(self._ebuild_pkg, &length)
+            self._defined_phases = frozenset(phases[i].decode() for i in range(length))
+            C.pkgcraft_str_array_free(phases, length)
+        return self._defined_phases
+
     @property
     def homepage(self):
         """Get a package's homepage."""

src/pkgcraft/pkgcraft_c.pxd

@@ -333,6 +333,12 @@ cdef extern from "pkgcraft.h":
     # The argument must be a non-null EbuildPkg pointer.
     DepSet *pkgcraft_ebuild_pkg_bdepend(EbuildPkg *p);
 
+    # Return a package's defined phases.
+    #
+    # # Safety
+    # The argument must be a non-null EbuildPkg pointer.
+    char **pkgcraft_ebuild_pkg_defined_phases(EbuildPkg *p, uintptr_t *len);
+
     # Return a package's DEPEND.
     #
     # Returns NULL on nonexistence.

tests/pkg/test_ebuild.py

@@ -122,6 +122,25 @@ def test_src_uri(self, repo):
         pkg = repo.create_pkg(src_uri='https://a.com/b.tar.gz')
         assert str(pkg.src_uri) == 'https://a.com/b.tar.gz'
 
+    def test_defined_phases(self, repo):
+        # none
+        pkg = repo.create_pkg()
+        assert not pkg.defined_phases
+
+        # single
+        data="src_configure() { :; }"
+        pkg = repo.create_pkg(data=data)
+        assert pkg.defined_phases == {'configure'}
+
+        # multiple
+        data=textwrap.dedent("""
+            src_prepare() { :; }
+            src_configure() { :; }
+            src_compile() { :; }
+        """)
+        pkg = repo.create_pkg(data=data)
+        assert pkg.defined_phases == {'prepare', 'configure', 'compile'}
+
     def test_homepage(self, repo):
         # none
         pkg = repo.create_pkg()