Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions examples/calculator_tools/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Init file for calculator_tools example module.
57 changes: 57 additions & 0 deletions examples/calculator_tools/calculator_tools.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Copyright (C) 2018 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Simple calculator example Fire CLI.

This module demonstrates the use of Fire without specifying a target component.
All functions become CLI commands when Fire() is invoked in main().

Example usage:
calculator_tools add 2 3
calculator_tools subtract 10 4
calculator_tools multiply 5 6
calculator_tools divide 20 5
"""

import fire


def add(a=0, b=0):
"""Return the sum of a and b."""
return a + b


def subtract(a=0, b=0):
"""Return a - b."""
return a - b


def multiply(a=0, b=0):
"""Return a * b."""
return a * b


def divide(a=0, b=1):
"""Return a / b."""
if b == 0:
raise ZeroDivisionError("Cannot divide by zero.")
return a / b


def main():
fire.Fire(name='calculator_tools')


if __name__ == '__main__':
main()
42 changes: 42 additions & 0 deletions examples/calculator_tools/calculator_tools_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Copyright (C) 2018 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Tests for the calculator_tools module."""

from fire import testutils
from examples.calculator_tools import calculator_tools


class CalculatorToolsTest(testutils.BaseTestCase):

def testCalculatorTools(self):
# add
self.assertEqual(calculator_tools.add(2, 3), 5)

# subtract
self.assertEqual(calculator_tools.subtract(10, 4), 6)

# multiply
self.assertEqual(calculator_tools.multiply(5, 2), 10)

# divide
self.assertEqual(calculator_tools.divide(20, 5), 4)

# division by zero
with self.assertRaises(ZeroDivisionError):
calculator_tools.divide(10, 0)


if __name__ == '__main__':
testutils.main()
1 change: 1 addition & 0 deletions examples/string_tools/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# string_tools package for Python Fire examples
50 changes: 50 additions & 0 deletions examples/string_tools/string_tools.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Copyright (C) 2018 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""String tools example Fire CLI.

This module demonstrates the use of Fire without specifying a target component.
By calling Fire() without arguments in main(), all functions defined in this
module become available as CLI commands.

Example usage:
string_tools reverse "Hello World"
string_tools uppercase "hello"
string_tools count-words "Hello world from Fire"
"""

import fire


def reverse(text=''):
"""Return the reversed string."""
return text[::-1]


def uppercase(text=''):
"""Return the text in uppercase."""
return text.upper()


def count_words(text=''):
"""Return the number of words in the text."""
return len(text.split())


def main():
fire.Fire(name='string_tools')


if __name__ == '__main__':
main()
37 changes: 37 additions & 0 deletions examples/string_tools/string_tools_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Copyright (C) 2018 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Tests for the string_tools module."""

from fire import testutils

from examples.string_tools import string_tools


class StringToolsTest(testutils.BaseTestCase):

def testStringTools(self):
# reverse
self.assertEqual(string_tools.reverse("Hello"), "olleh")

# uppercase
self.assertEqual(string_tools.uppercase("hello"), "HELLO")

# count_words
self.assertEqual(string_tools.count_words("Hello world"), 2)
self.assertEqual(string_tools.count_words("one two three four"), 4)


if __name__ == '__main__':
testutils.main()