xpath-string 0.2.4

Module which allows to make xpath operations over string which represent xpath

xpath-string

Simple module providing operations on Xpath string

Currently only addition of xpath is supported

Xpath Object

• Initialization

  from xpath_string.xpath import Xpath
  
  xpath_object = Xpath('//some[@xpath="string"]')

• Attributes:

  xpath - xpath string (type: ‘str’)

Xpath Adding

• Xpath object + string

  Result of addition string to Xpath object is Xpath object. Adding string to Xpath object is the same as adding two strings.

  xpath_object = Xpath('//some[@xpath="string"]')
  string = '//div[@class="name"]'
  result = xpath_object + string
  
  # result == '//some[@xpath="string"]//div[@class="name"]'
  # result.xpath == '//some[@xpath="string"]//div[@class="name"]'

  Same situation is when Xpath object represents xpath string with OR operator

  xpath_object = Xpath('//some[@xpath="string"]|\\span')
  string = '//div[@class="name"]'
  
  result = xpath_object + string
  # result == '//some[@xpath="string"]|//span//div[@class="name"]'
  # result.xpath == '//some[@xpath="string"]|//span//div[@class="name"]'

• Xpath object + Xpath object

  Result of addition Xpath object to Xpath object is Xpath Object.

  xpath_object_1 = Xpath('//some[@xpath="string"]')
  xpath_object_2 = Xpath('//div[@class="name"]')
  
  result = xpath_object_1 + xpath_object_2
  # result == '//some[@xpath="string"]//div[@class="name"]'
  # result.xpath == '//some[@xpath="string"]//div[@class="name"]'

  When at least one Xpath object has or operator in main part of xpath (not inside square brackets):

  xpath_object_1 = Xpath('//some[@xpath="string"]|//span')
  xpath_object_2 = Xpath('//div[@class="name"]')
  
  result_1 = xpath_object_1 + xpath_object_2
  # result_1 == '//some[@xpath="string"]//div[@class="name"|//span//div[@class="name"]'
  # result_1.xpath == '//some[@xpath="string"]//div[@class="name"|//span//div[@class="name"]'
  
  result_2 = xpath_object_2 + xpath_object_1
  # result_2 == '//div[@class="name"]//some[@xpath="string"]|//div[@class="name"]//span'
  # result_2.xpath == '//div[@class="name"]//some[@xpath="string"]|//div[@class="name"]//span'

Xpath.format()

The string built-in is overwrote. Xpath.format(‘some string’) is formatting xpath string attribute of a Object. It returns new Xpath object with ‘formatted’ xpath attribute.

Example:

xpath_object_1 = Xpath('//some[@xpath="{}"]')
xpath_object_2 = xpath_object_1.format('new')
# xpath_object_1 == Xpath('//some[@xpath="{}"]')
# xpath_object_2 == Xpath('//some[@xpath="new"]')

xpath_object_3 = Xpath('//some[@xpath="{sth}"]')
xpath_object_4 = xpath_object_1.format(sth='one')
# xpath_object_3 == Xpath('//some[@xpath="{sth}"]')
# xpath_object_4 == Xpath('//some[@xpath="one"]')