google / google/python-fire

Output of the example for grouping in docs is wrong

Đang mở
#333 3 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Python
Star
28.2k
Fork
1.5k
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Hello.

In the Group Commands section (https://github.com/google/python-fire/blob/master/docs/guide.md#grouping-commands), the example code is

```python
class IngestionStage(object):

def run(self):
return 'Ingesting! Nom nom nom...'

class DigestionStage(object):

def run(self, volume=1):
return ' '.join(['Burp!'] * volume)

def status(self):
return 'Satiated.'

class Pipeline(object):

def __init__(self):
self.ingestion = IngestionStage()
self.digestion = DigestionStage()

def run(self):
self.ingestion.run()
self.digestion.run()
return 'Pipeline complete'

if __name__ == '__main__':
fire.Fire(Pipeline)
```

and according to the guide

```bash
$ python example.py run
Ingesting! Nom nom nom...
Burp!
```

However, the output is wrong. It should be

```bash
$ python example.py run
Pipeline complete
```

This can be easily fixed.
However, in order to demonstrate the pipeline functionality, I would suggest to change the example to

```python
class IngestionStage(object):

def run(self):
return 'Ingesting! Nom nom nom...'

class DigestionStage(object):

def run(self, volume=1):
return ' '.join(['Burp!'] * volume)

def status(self):
return 'Satiated.'

class Pipeline(object):

def __init__(self):
self.ingestion = IngestionStage()
self.digestion = DigestionStage()

def run(self):
ingestion_output = self.ingestion.run()
digestion_output = self.digestion.run()
return ingestion_output + digestion_output

if __name__ == '__main__':
fire.Fire(Pipeline)
```

and accordingly the output should be

```bash
$ python example.py run
Ingesting! Nom nom nom...Burp!
```

I would like to know which change @dbieber would like.
Thank you.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.