How to get layers in x number of subgroups?

Question

I have a project which has dozens of groups and subgroups. E.g.:

Main_Group > Sub_Group_1 > Sub_Group_1A > Layer_1A
                                        > Layer_2A

How can I access those layers which are contained within Sub_Group_1A?

I currently have this:

root = QgsProject.instance().layerTreeRoot()
for child in root.children():
  if isinstance(child, QgsLayerTreeGroup):
    if child.name() == "Main_Group":
        for subChild in child.children():
            if isinstance(subChild, QgsLayerTreeGroup):
                if subChild.name() == 'Sub_Group_1':
                    # What next?

I have read through the following sources and can get layers in Sub_Group_1 but not in Sub_Group_1A:

Would you like to access all layers in the tree or would you like to access specifically those of the Sub_Group_1A? — Germán Carrillo, Apr 21 '16 at 15:05
@GermánCarrillo - Apologies, I should edit the question to make this clear. Specifically layers within Sub_Group_1A. If you can post an answer showing a more cleaner piece of code than what I posted, I will happily accept it :) — Joseph, Apr 21 '16 at 15:07
Just asked because the other option I mentioned in the comment is also interesting, but it's a different one. — Germán Carrillo, Apr 21 '16 at 15:16
@GermánCarrillo - Is that by any chance related to this post: PyQGIS: How to get the list of valid layers in TOC?? — Joseph, Apr 21 '16 at 15:19

score 4 · Accepted Answer · answered Apr 21 '16 at 15:12

4

There is a handy option in the QgsLayerTreeGroup class that you can use: findGroup. It traverses the whole tree. So, in your case, this would be enough:

root = QgsProject.instance().layerTreeRoot()
subGroup1A = root.findGroup('Sub_Group_1A')
for child in subGroup1A.children():
    if isinstance(child, QgsLayerTreeLayer):
        child.layerName()

answered Apr 21 '16 at 15:12

Germán Carrillo

36,307
5
123
178

2

Fantastic stuff! Many thanks =). I noticed this was briefly mentioned in the first source referenced, guess I overlooked it. – Joseph Apr 21 '16 at 15:15

score 0 · Answer 2 · answered Apr 21 '16 at 14:56

Eugh, I guess one method is to:

Search the children of Main_group, then
Search the children of Sub_Group_1 and then
Search the children of Sub_Group_1A.

Basically repeating the loops, I'm hoping there is a much nicer and efficient way of accessing those layers but for now, here's the code I used:

root = QgsProject.instance().layerTreeRoot()
for child in root.children():
    if isinstance(child, QgsLayerTreeGroup):
        if child.name() == "Main_Group":
            for subChild in child.children():
                if isinstance(subChild, QgsLayerTreeGroup):
                    if subChild.name() == 'Sub_Group_1':
                        if isinstance(subChild, QgsLayerTreeGroup):
                            for sub_subChild in subChild.children():
                                if isinstance(sub_subChild, QgsLayerTreeGroup):
                                    if sub_subChild.name() == 'Sub_Group_1A':
                                        for layers in sub_subChild.children():
                                            print layers.layerName()

score 0 · Answer 3 · answered Nov 30 '20 at 11:30

For x number of subgroups you can use that script:

def getLayersOfGroup(group):
    """That function find all layers under given group"""
    for child in group.children():
        if isinstance(child, QgsLayerTreeLayer):
            print(child.layer().name()
        elif isinstance(child, QgsLayerTreeGroup):
            getLayersOfGroup(child)
root = QgsProject.instance().layerTreeRoot()
group = root.findGroup("GROUP NAME")
if group:
    getLayersOfGroup(group)

How to get layers in x number of subgroups?

3 Answers3