File: android_manifest.py

package info (click to toggle)
android-platform-development 8.1.0%2Br23-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 37,780 kB
  • sloc: ansic: 166,133; xml: 75,737; java: 19,329; python: 11,511; cpp: 8,221; sh: 2,075; lisp: 261; ruby: 183; asm: 132; perl: 129; makefile: 18
file content (127 lines) | stat: -rw-r--r-- 3,747 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
#!/usr/bin/python2.4
#
#
# Copyright 2009, The Android Open Source Project
#
# 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.

"""In memory representation of AndroidManifest.xml file.

Specification of AndroidManifest.xml can be found at
http://developer.android.com/guide/topics/manifest/manifest-intro.html
"""

# python imports
import os
import xml.dom.minidom
import xml.parsers


class AndroidManifest(object):
  """In memory representation of AndroidManifest.xml file."""

  FILENAME = 'AndroidManifest.xml'

  def __init__(self, app_path=None):
    if app_path:
      self._ParseManifest(app_path)

  def GetAppPath(self):
    """Retrieve file system path to this manifest file's directory."""
    return self._app_path

  def GetPackageName(self):
    """Retrieve package name defined at <manifest package="...">.

    Returns:
      Package name if defined, otherwise None
    """
    manifest = self._GetManifestElement()
    if not manifest or not manifest.hasAttribute('package'):
      return None
    return manifest.getAttribute('package')

  def _ParseManifest(self, app_path):
    """Parse AndroidManifest.xml at the specified path.

    Args:
      app_path: path to folder containing AndroidManifest.xml
    Raises:
      IOError: AndroidManifest.xml cannot be found at given path, or cannot be
          opened for reading
    """
    self._app_path = app_path
    self._manifest_path = os.path.join(app_path, self.FILENAME)
    self._dom = xml.dom.minidom.parse(self._manifest_path)

  def AddUsesSdk(self, min_sdk_version):
    """Adds a uses-sdk element to manifest.

    Args:
      min_sdk_version: value to provide for minSdkVersion attribute.
    """
    manifest = self._GetManifestElement()
    uses_sdk_elements = manifest.getElementsByTagName('uses-sdk')
    if uses_sdk_elements:
      uses_sdk_element = uses_sdk_elements[0]
    else:
      uses_sdk_element = self._dom.createElement('uses-sdk')
      manifest.appendChild(uses_sdk_element)

    uses_sdk_element.setAttribute('android:minSdkVersion', min_sdk_version)
    self._SaveXml()

  def GetInstrumentationNames(self):
    """Get the instrumentation names from manifest.

    Returns:
      list of names, might be empty
    """
    instr_elements = self._dom.getElementsByTagName('instrumentation')
    instrs = []
    for element in instr_elements:
      instrs.append(element.getAttribute('android:name'))
    return instrs

  def _GetManifestElement(self):
    """Retrieve the root manifest element.

    Returns:
      the DOM element for manifest or None.
    """
    manifests = self._dom.getElementsByTagName('manifest')
    if not manifests:
      return None
    return manifests[0]

  def _SaveXml(self):
    """Saves the manifest to disk."""
    self._dom.writexml(open(self._manifest_path, mode='w'), encoding='utf-8')


def CreateAndroidManifest(path):
  """Factory method for creating a AndroidManifest.

  Args:
    path: the directory for the manifest file

  Return:
    the AndroidManifest or None if there was no file present
  """
  manifest_path = os.path.join(path, AndroidManifest.FILENAME)
  if os.path.isfile(manifest_path):
    manifest = AndroidManifest()
    manifest._ParseManifest(path)
    return manifest
  else:
    return None